branch: externals/org-transclusion commit f7215e01db813ae3af18997d3caaa7e0bc7a6cbb Author: Noboru Ota <m...@nobiot.com> Commit: Noboru Ota <m...@nobiot.com>
docs:GitHub online user manual --- docs/index.html | 23 +++++++++++++++++------ docs/org-transclusion-manual.org | 2 ++ 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/docs/index.html b/docs/index.html index e411895f5f..af1d47dbe9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -60,9 +60,9 @@ Next: <a href="#Example-Use-Cases-_0026-Main-Features" accesskey="n" rel="next"> <span id="Org_002dtransclusion-User-Manual"></span><h1 class="top">Org-transclusion User Manual</h1> -<p>This manual is for Org-transclusion {{{version:}}}. +<p>This manual is for Org-transclusion 1.0.x. </p> -<p>Last updated: {{{modified:}}}. +<p>Last updated: 26 December 2021. </p> <p>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.<span id="whatis"></span></p> <p>Copyright (C) 2021 Free Software Foundation, Inc. @@ -220,11 +220,22 @@ Next: <a href="#Getting-Started" accesskey="n" rel="next">Getting Started</a>, P </div> <span id="Installation-1"></span><h2 class="chapter">2 Installation</h2> -<p>This package is available on <a href="https://elpa.gnu.org/packages/org-transclusion.html">GNU ELPA</a>. You can do ‘<samp>M-x package-install RET -org-transclusion</samp>’ to install it. After installation, you can start using -Org-transclusion. +<p>This package is available on: </p> -<p>Below are some example keybindings that can be put into your Emacs configuration. +<ul> +<li> <a href="https://elpa.gnu.org/packages/org-transclusion.html">GNU ELPA</a> (releases only; equivalent to MELPA-Stable) +</li><li> <a href="https://elpa.gnu.org/devel/org-transclusion.html">GNU-devel ELPA</a> (unreleased development branch; equivalent to MELPA) +</li></ul> + +<p>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 ‘<samp>package-archives</samp>’ like this: +</p> +<div class="lisp"> +<pre class="lisp">(add-to-list 'package-archives '("gnu-devel" . "https://elpa.gnu.org/devel/") t) +</pre></div> + +<p>Refresh the archive with ‘<samp>M-x package-refresh-contents RET</samp>’ and you can do ‘<samp>M-x package-install RET org-transclusion</samp>’ to install it. Alternatively, you can use ‘<samp>package-list-packages</samp>’. +</p> +<p>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. </p> <div class="lisp"> <pre class="lisp">(define-key global-map (kbd "<f12>") #'org-transclusion-add) diff --git a/docs/org-transclusion-manual.org b/docs/org-transclusion-manual.org index 4500434d4f..5f9f3ea031 100644 --- a/docs/org-transclusion-manual.org +++ b/docs/org-transclusion-manual.org @@ -48,6 +48,7 @@ modify this GNU manual.” #+transclude: [[../README.org::#use-cases]] :only-contents + * Installation #+transclude: [[../README.org::*Installation]] :only-contents @@ -635,6 +636,7 @@ It seems like this could work well for headlines, and named tables, src blocks, #+transclude: [[../README.org::*Contributing]] :only-contents + * Index - Features :PROPERTIES: :APPENDIX: t