[elpa] externals/org-transclusion ad766f589e 1/2: docs:README img & line ending

[ELPA Syncer]

branch: externals/org-transclusion
commit ad766f589e02be0d816aa0cbe3451d6af72efa07
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    docs:README img & line ending
---
 README.org | 277 +++++++++++++++++++++++++++++++------------------------------
 1 file changed, 140 insertions(+), 137 deletions(-)

diff --git a/README.org b/README.org
index ae4704735a..04a0f294b8 100644
--- a/README.org
+++ b/README.org
@@ -1,137 +1,140 @@
-#+title:  Org-transclusion README
-#+author: Noboru Ota 
-#+email:  me@nobiot.com
-#+options: toc:nil
-
-#+html: <a href="https://www.gnu.org/software/emacs/";><img alt="GNU Emacs" 
src="https://img.shields.io/static/v1?logo=gnuemacs&logoColor=fafafa&label=Made%20for&message=GNU%20Emacs&color=7F5AB6&style=flat"/></a>
-#+html: <a href="http://elpa.gnu.org/packages/org-transclusion.html";><img 
alt="GNU ELPA" src="https://elpa.gnu.org/packages/org-transclusion.svg"/></a>
-#+html: <a href="http://elpa.gnu.org/devel/org-transclusion.html";><img 
alt="GNU-devel ELPA" src="https://elpa.gnu.org/devel/org-transclusion.svg"/></a>
-#+html: <img alt="GPLv3" 
src="https://img.shields.io/badge/License-GPLv3-blue.svg";>
-
-Org-transclusion lets you insert a copy of text content via a file link or ID 
link within an Org file. It lets you have the same content present in different 
buffers at the same time without copy-and-pasting it. Edit the source of the 
content, and you can refresh the transcluded copies to the up-to-date state. 
Org-transclusion keeps your files clear of the transcluded copies, leaving only 
the links to the original content.<<whatis>>
-
-A complete [[https://nobiot.github.io/org-transclusion/][user manual]] is 
available online or Emacs in-system as an Info document (=C-h i= and find the 
=Org-transclusion= node).
-
-For installation and minimum configuration, refer to 
[[#installation][Installation]] below or the corresponding section in the user 
manual.
-
-[[https://nobiot.github.io/org-transclusion/#Getting-Started][Getting 
Started]] in the user manual will get you started in 5 minutes.
-
-Below are images and videos demonstrating some of the key features of
-Org-transclusion.
-
-#+attr_html: :max-width 80%
-https://github.com/nobiot/org-transclusion/blob/main/resources/2021-09-10-transclusion.gif?raw=true
-*Figure 1*. Animation to show creation of a transclusion from an ID link
-
-#+attr_html: :max-width 80%
-https://github.com/nobiot/org-transclusion/blob/main/resources/2021-05-01-org-transclusion-0.1.0-live-sync.gif?raw=true
-*Figure 2*. Animation to show live sync from transclusion to source
-
-#+attr_html: :max-width 80%
-https://github.com/nobiot/org-transclusion/blob/main/resources/demo9-title.png?raw=true
-*Figure 3*. [[https://youtu.be/ueaPiA622wA][Video demo on v0.2.1 on YouTube]] 
demonstrating new features to transclude a source file into a src-block and 
function to specify a range of text/source line
-  
-- Older videos
-      
-  + [[https://youtu.be/idlFzWeygwA][Video demo on v0.2.0 on YouTube]] 
featuring minor breaking changes and new transclusion filters
-
-  + [[https://youtu.be/idlFzWeygwA][Video demo on v0.1.1 on YouTube]] 
featuring basic syntax and live-sync edit
-
-* Example Use Cases & Main Features
-:PROPERTIES:
-:CUSTOM_ID: use-cases
-:END:
-
-Here are a summary of some real use cases that users have shared with the 
author, including his own.
-
-- Book writing ::
-  
-  You have a collection of notes. You can quickly transclude paragraphs and 
sections from your notes and put together a draft. As transclusions are links, 
it's easy to re-organize them into different sequences to see which way works 
the best. 
-
-- Academic writing ::
-  
-  You have a collection of quotes and notes from your research and literature 
review. Transclude relevant elements of quotes and notes into different papers. 
You can keep your collection as the central repository of your research.
-
-- Technical writing ::
-
-  You write technical documents for software. Transclude relevant lines of 
code into the document. As the code is only transcluded, you can keep the 
document up-to-date as the code evolves.
-
-- Project status reports ::
-
-  You work on multiple projects at the same time and need to report to 
different project managers. Transclude relevant parts of your work notes and 
logs into respective project reports. You can keep a single collection of your 
work notes and logs.
-
-Main Features:
-
-- Insert a copy of text content via a file link or ID link into an Org file
-
-- Work with any text file such as program source code, plain text, Markdown, 
or other Org files
-
-- Keep the file system clear of the copies of text content -- Org-transclusion 
tries hard to save only the links to the file system
-
-- For Org files, use different headline levels from the source Org file
-
-- For Org files, use filters to include only relevant elements (e.g. filter 
out properties in the transclusions)
-
-- For program source and plain text files, transclude a certain lines or 
dynamically specify the from/to lines to keep the transclusion always 
up-to-date with the evolving source files
-
-- For program source files, transclude parts or whole code directly into Org's 
source block to leverage the rich Org features including noweb style syntax
-
-- Extend Org-transclusion with its extension framework
-
-* Installation
-:PROPERTIES:
-:CUSTOM_ID: installation
-:END:
-
-This package is available on:
-
-- [[https://elpa.gnu.org/packages/org-transclusion.html][GNU ELPA]] (releases 
only; equivalent to MELPA-Stable)
-- [[https://elpa.gnu.org/devel/org-transclusion.html][GNU-devel ELPA]] 
(unreleased development branch; equivalent to MELPA)
-
-GNU ELPA should be already set up in your Emacs by default. If you wish to add 
GNU-devel ELPA, simply add its URL to =package-archives= like this:
-
-#+BEGIN_SRC elisp
-  (add-to-list 'package-archives '("gnu-devel" . 
"https://elpa.gnu.org/devel/";) t)
-#+END_SRC
-
-Refresh the archive with =M-x package-refresh-contents RET= and you can do 
=M-x package-install RET org-transclusion= to install it. Alternatively, you 
can use =package-list-packages=. 
-
-After installation, you can start using Org-transclusion with no additional 
configuration. Below are some example keybindings that can be put into your 
Emacs configuration.
-
-#+BEGIN_SRC elisp
-  (define-key global-map (kbd "<f12>") #'org-transclusion-add)
-  (define-key global-map (kbd "C-n t") #'org-transclusion-mode)
-#+END_SRC
-
-For Doom users, you would need to do something like this below to install the 
package and configure the keybindings. 
-
-#+BEGIN_SRC elisp
-;; ~/.doom.d/package.el
-(package! org-transclusion)
-#+END_SRC
-
-#+BEGIN_SRC elisp
-;; ~/.doom.d/config.el
-(use-package! org-transclusion
-  :after org
-  :init
-  (map!
-   :map global-map "<f12>" #'org-transclusion-add
-   :leader
-   :prefix "n"
-   :desc "Org Transclusion Mode" "t" #'org-transclusion-mode))
-#+END_SRC
-
-* Contributing
-
-- Get involved in a discussion in 
[[https://org-roam.discourse.group/t/prototype-transclusion-block-reference-with-emacs-org-mode/830][Org-roam
 forum]] (the package is originally aimed for its users, me included)
-
-- Create issues, discussion, and/or pull requests. All welcome.
-
-Org-transclusion is part of GNU ELPA and thus copyrighted by the 
[[http://fsf.org][Free Software Foundation]] (FSF). This means that anyone who 
is making a substantive code contribution will need to "assign the copyright 
for your contributions to the FSF so that they can be included in GNU Emacs" 
([[https://orgmode.org/contribute.html#copyright][Org Mode website]]).
-
-Thank you.
-
-* License
-
-Org-transclusion is licensed under a GPLv3 license. For a full copy of the 
license, refer to [[./LICENSE][LICENSE]].
+#+title:  Org-transclusion README
+#+author: Noboru Ota 
+#+email:  me@nobiot.com
+#+options: toc:nil
+
+#+html: <a href="https://www.gnu.org/software/emacs/";><img alt="GNU Emacs" 
src="https://img.shields.io/static/v1?logo=gnuemacs&logoColor=fafafa&label=Made%20for&message=GNU%20Emacs&color=7F5AB6&style=flat"/></a>
+#+html: <a href="http://elpa.gnu.org/packages/org-transclusion.html";><img 
alt="GNU ELPA" src="https://elpa.gnu.org/packages/org-transclusion.svg"/></a>
+#+html: <a href="http://elpa.gnu.org/devel/org-transclusion.html";><img 
alt="GNU-devel ELPA" src="https://elpa.gnu.org/devel/org-transclusion.svg"/></a>
+#+html: <img alt="GPLv3" 
src="https://img.shields.io/badge/License-GPLv3-blue.svg";>
+
+Org-transclusion lets you insert a copy of text content via a file link or ID 
link within an Org file. It lets you have the same content present in different 
buffers at the same time without copy-and-pasting it. Edit the source of the 
content, and you can refresh the transcluded copies to the up-to-date state. 
Org-transclusion keeps your files clear of the transcluded copies, leaving only 
the links to the original content.<<whatis>>
+
+A complete [[https://nobiot.github.io/org-transclusion/][user manual]] is 
available online or Emacs in-system as an Info document (=C-h i= and find the 
=Org-transclusion= node).
+
+For installation and minimum configuration, refer to 
[[#installation][Installation]] below or the corresponding section in the user 
manual.
+
+[[https://nobiot.github.io/org-transclusion/#Getting-Started][Getting 
Started]] in the user manual will get you started in 5 minutes.
+
+Below are images and videos demonstrating some of the key features of
+Org-transclusion.
+
+#+attr_html: :max-width 80%
+[[https://github.com/nobiot/org-transclusion/blob/main/resources/2021-09-10-transclusion.gif?raw=true]]
+
+*Figure 1*. Animation to show creation of a transclusion from an ID link
+
+#+attr_html: :max-width 80%
+[[https://github.com/nobiot/org-transclusion/blob/main/resources/2021-05-01-org-transclusion-0.1.0-live-sync.gif?raw=true]]
+
+*Figure 2*. Animation to show live sync from transclusion to source
+
+#+attr_html: :max-width 80%
+[[https://github.com/nobiot/org-transclusion/blob/main/resources/demo9-title.png?raw=true]]
+
+*Figure 3*. [[https://youtu.be/ueaPiA622wA][Video demo on v0.2.1 on YouTube]] 
demonstrating new features to transclude a source file into a src-block and 
function to specify a range of text/source line
+  
+- Older videos
+      
+  + [[https://youtu.be/idlFzWeygwA][Video demo on v0.2.0 on YouTube]] 
featuring minor breaking changes and new transclusion filters
+
+  + [[https://youtu.be/idlFzWeygwA][Video demo on v0.1.1 on YouTube]] 
featuring basic syntax and live-sync edit
+
+* Example Use Cases & Main Features
+:PROPERTIES:
+:CUSTOM_ID: use-cases
+:END:
+
+Here is a summary of some real use cases that users have shared with the 
author, including his own.
+
+- Book writing ::
+  
+  You have a collection of notes. You can quickly transclude paragraphs and 
sections from your notes and put together a draft. As transclusions are links, 
it's easy to re-organize them into different sequences to see which way works 
the best. 
+
+- Academic writing ::
+  
+  You have a collection of quotes and notes from your research and literature 
review. Transclude relevant elements of quotes and notes into different papers. 
You can keep your collection as the central repository of your research.
+
+- Technical writing ::
+
+  You write technical documents for software. Transclude relevant lines of 
code into the document. As the code is only transcluded, you can keep the 
document up-to-date as the code evolves.
+
+- Project status reports ::
+
+  You work on multiple projects at the same time and need to report to 
different project managers. Transclude relevant parts of your work notes and 
logs into respective project reports. You can keep a single collection of your 
work notes and logs.
+
+Main Features:
+
+- Insert a copy of text content via a file link or ID link into an Org file
+
+- Work with any text file such as program source code, plain text, Markdown, 
or other Org files
+
+- Keep the file system clear of the copies of text content -- Org-transclusion 
tries hard to save only the links to the file system
+
+- For Org files, use different headline levels from the source Org file
+
+- For Org files, use filters to include only relevant elements (e.g. filter 
out properties in the transclusions)
+
+- For program source and plain text files, transclude a certain lines or 
dynamically specify the from/to lines to keep the transclusion always 
up-to-date with the evolving source files
+
+- For program source files, transclude parts or whole code directly into Org's 
source block to leverage the rich Org features including noweb style syntax
+
+- Extend Org-transclusion with its extension framework
+
+* Installation
+:PROPERTIES:
+:CUSTOM_ID: installation
+:END:
+
+This package is available on:
+
+- [[https://elpa.gnu.org/packages/org-transclusion.html][GNU ELPA]] (releases 
only; equivalent to MELPA-Stable)
+- [[https://elpa.gnu.org/devel/org-transclusion.html][GNU-devel ELPA]] 
(unreleased development branch; equivalent to MELPA)
+
+GNU ELPA should be already set up in your Emacs by default. If you wish to add 
GNU-devel ELPA, simply add its URL to =package-archives= like this:
+
+#+BEGIN_SRC elisp
+  (add-to-list 'package-archives '("gnu-devel" . 
"https://elpa.gnu.org/devel/";) t)
+#+END_SRC
+
+Refresh the archive with =M-x package-refresh-contents RET= and you can do 
=M-x package-install RET org-transclusion= to install it. Alternatively, you 
can use =package-list-packages=. 
+
+After installation, you can start using Org-transclusion with no additional 
configuration. Below are some example keybindings that can be put into your 
Emacs configuration.
+
+#+BEGIN_SRC elisp
+  (define-key global-map (kbd "<f12>") #'org-transclusion-add)
+  (define-key global-map (kbd "C-n t") #'org-transclusion-mode)
+#+END_SRC
+
+For Doom users, you would need to do something like this below to install the 
package and configure the keybindings. 
+
+#+BEGIN_SRC elisp
+;; ~/.doom.d/package.el
+(package! org-transclusion)
+#+END_SRC
+
+#+BEGIN_SRC elisp
+;; ~/.doom.d/config.el
+(use-package! org-transclusion
+  :after org
+  :init
+  (map!
+   :map global-map "<f12>" #'org-transclusion-add
+   :leader
+   :prefix "n"
+   :desc "Org Transclusion Mode" "t" #'org-transclusion-mode))
+#+END_SRC
+
+* Contributing
+
+- Get involved in a discussion in 
[[https://org-roam.discourse.group/t/prototype-transclusion-block-reference-with-emacs-org-mode/830][Org-roam
 forum]] (the package is originally aimed for its users, me included)
+
+- Create issues, discussion, and/or pull requests. All welcome.
+
+Org-transclusion is part of GNU ELPA and thus copyrighted by the 
[[http://fsf.org][Free Software Foundation]] (FSF). This means that anyone who 
is making a substantive code contribution will need to "assign the copyright 
for your contributions to the FSF so that they can be included in GNU Emacs" 
([[https://orgmode.org/contribute.html#copyright][Org Mode website]]).
+
+Thank you.
+
+* License
+
+Org-transclusion is licensed under a GPLv3 license. For a full copy of the 
license, refer to [[./LICENSE][LICENSE]].