[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org-transclusion f950c2286f 1/3: doc: update docs for v
From: |
ELPA Syncer |
Subject: |
[elpa] externals/org-transclusion f950c2286f 1/3: doc: update docs for v1.2.0 |
Date: |
Tue, 11 Jan 2022 11:57:40 -0500 (EST) |
branch: externals/org-transclusion
commit f950c2286f5fa25a84de043a302eebbc0d9cf457
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>
doc: update docs for v1.2.0
---
NEWS => CHANGELOG | 56 --------------------------------
NEWS | 70 +++++++++-------------------------------
docs/org-transclusion-manual.org | 23 +++++++++++--
3 files changed, 35 insertions(+), 114 deletions(-)
diff --git a/NEWS b/CHANGELOG
similarity index 63%
copy from NEWS
copy to CHANGELOG
index 098b906f95..c122d146ea 100644
--- a/NEWS
+++ b/CHANGELOG
@@ -1,59 +1,3 @@
-* Version 1.1.1
-
- - Fix ::
-
- - Fix rare but destructive issue where buffer text content could be deleted
- by removing a transclusion. This could happen by killing a second Emacs
- instance (batch or online) or buffer, while the first Emacs keeps
- transclusions added
-
- - Other:
-
- - User Manual now refers to v1.1.x
-
-* Version 1.1.0
-
- - Change ::
-
- - add:inhibit-read-only: fix:Org export errors with read-only
- With this, noweb expansion works now (limitation removed)
-
- - Fix ::
-
- - fix:#105 org-element--cache issue for Org v9.6
- Remove use of silent-modificaiton & inhibit-modification-hook
- - fix:add-all not to stop with error in one trasclusion
- - fix:Remove extra space/line added to Org elements transcluded
-
- - Other ::
- - README, Info doc user manual, online user manual
-
-* Version 1.0.1
-
- - Add .elpaignore
- - Bump up version only to enable ELPA; no functional changes
-
-* Version 1.0.0
-
- - Initial version available on ELPA (https://elpa.gnu.org/)
-
- - Feature ::
-
- - =:end= property and a search term to dynamically define a range of lines
to transclude for text and
- source code block
-
- - Change ::
-
- - Now user option =org-transclusion-include-first-section='s default value
- is changed to =t=. This seems to be more intuitive for more users
-
- - Fix ::
-
- - =org-transclusion-before-kill= now checks if the buffer to be killed
- contains any transclusion AND it is visting a file before saving. This
- fixes some issues related to temp buffers, etc.
- - fix: search options for src-lines extension for =:lines=, =:src=, and
=:end= properties
-
* Changelog before Version 1.0.0
** 0.2.2
diff --git a/NEWS b/NEWS
index 098b906f95..e951a27c63 100644
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,16 @@
+* Version 1.2.0
+ - Feature ::
+
+ - add: org-transclusion-after-add-hook
+
+ - Fix ::
+
+ - fix: org-transclusion-map now inherits org-mode-map (thanks to ag91 [1])
+ - fix: reverting 252ec675; shouldn't remove the extra space at the end of
+ transclusions from Org
+ - fix: #115 allow adding #+name, etc. before #+transclude keyword
+ (don't remove affiliated keywords when org-transclusoin-remove)
+
* Version 1.1.1
- Fix ::
@@ -54,58 +67,5 @@
fixes some issues related to temp buffers, etc.
- fix: search options for src-lines extension for =:lines=, =:src=, and
=:end= properties
-* Changelog before Version 1.0.0
-
-** 0.2.2
-- New Features ::
- - #+transclude font-lock and new face =org-transclusion-keyword=
- - Selective extensions with =org-transclusion-extensions=
- - (optional extension) Support for org-indent
-- Fix ::
- - fix: #93 open-source error "Live sync cannot start here"
-
-** 0.2.1
-- New Features ::
- - Transclude a source file into a =src= block
- - Transclude a range of lines for text and source files
- - Main relevant commits:
- + 6e0e4bf * | feat: :src, :lines, :rest props (WIP)
-
-** 0.2.0
-- Breaking changes ::
- Refer to the updated README on new features and changed command names
- - Change names of commands
- - Remove t/nil to #+transclude: syntax
- - Add :disable-auto
- - Main relevant commits:
- + 2ba90f0 * break: change command and function names
- + 6cdd836 * | intrnl: v0.2.0 (breaking change)
- + 765d8ee * add :disable-auto
-
-- New features and improvements ::
- Refer to the updated README on new features and changed command names
- - 7e5c839 * feat: exclude-elements
- - 765d8ee * add :disable-auto
- - afd6d80 * add: :only-contents
- - cbb1c25 * add: apply :level to buffer with first section ::
- Fix #47 The first section itself does not get influenced by :level
property. The first headline, when present, is treated as the first headline,
thus :exclude-element "headline" affects its sub-headlines; this means that the
content of the first headline is transcluded even when with "headline" in the
list of excluded elements.
-
-** 0.1.2
-- e08df47 * add: live-sync for non-Org text file ::
- So far Non-Org text files could be transcluded but live-sync was not
available. This version enables live-sync for them. Only for the whole file at
the moment (ability to specify parts of a text file is considered)
-
-- a576b34 * add: text-clone library (rename) ::
- Live-sync features are now factored out into =text-clone= as a standalone
library (available with =text-clone.el= also included in this repo). Refactored
so that =org-transclusion= uses (and requires) =text-clone=.
-
-** 0.1.1
-- 49f03b1 * feat: current-indentation ::
- Org-transclusion now keeps the original indentation of the keyword. When a
transclusion text region is removed, its keyword will be indented as it was
-
-- d55fc39 * chg: save-buffer hooks ::
- Instead of blindly deactivate and activate all transclusions with t flag,
this variable is meant to provide mechanism to deactivate/activate only the
transclusions currently in effect to copy a text content.
-
-- 64fd182 * add: remove live-sync overlays when deleted ::
- Closes issue [[https://github.com/nobiot/org-transclusion/issues/8][#8]]
Adding a mechanism to remove both of the live-sync overlays (transclusion and
source) when transclusion is completely deleted. This solves the problem of a
source overlay to be orphaned in such cases.
-
-** 0.1.0
-As described in this version.
+† Changes before Version 1.0.0 are in CHANGELOG file.
+
diff --git a/docs/org-transclusion-manual.org b/docs/org-transclusion-manual.org
index b295fd2708..ac68b2a7e8 100644
--- a/docs/org-transclusion-manual.org
+++ b/docs/org-transclusion-manual.org
@@ -1,7 +1,7 @@
#+title: Org-transclusion User Manual
#+author: Noboru Ota <me@nobiot.com>
#+macro: version 1.1.x
-#+macro: modified 07 January 2022
+#+macro: modified 11 January 2022
#+language: en
#+export_file_name: org-transclusion.texi
@@ -116,7 +116,7 @@ e org-transclusion-live-sync-start
g org-transclusion-refresh
o org-transclusion-open-source
- †‧Also inherits ‘org-mode-map’ as of development version
1.1.1.0.20220106.203639
+ † Also inherits ‘org-mode-map’ as of development version
1.1.1.0.20220106.203639
and planned to be part of 1.2.0
#+end_example
@@ -325,7 +325,7 @@ In the live-sync edit region, the normal =yank= command
(=C-y=) is replaced with
C-c C-c org-transclusion-live-sync-exit
- †‧Also inherits ‘org-mode-map’
+ † Also inherits ‘org-mode-map’
#+end_example
** Transclude source file into src-block
@@ -468,6 +468,8 @@ Currently, the following extensions are available.
#+vindex: org-transclusion-add-all-on-activate
#+vindex: org-transclusion-mode-lighter
#+vindex: org-transclusion-open-source-display-action-list
+#+vindex: org-transclusion-after-add-functions
+#+cindex: Hooks - org-transclusion-after-add-functions
You can customize settings in the =org-transclusion= group.
@@ -494,6 +496,21 @@ You can customize settings in the =org-transclusion= group.
- =org-transclusion-mode-lighter= :: Define the lighter for Org-transclusion
minor mode. The default is " OT".
+- =org-transclusion-after-add-functions= :: Functions to be called after a
+ transclusion content has been added. The hook runs after the content and the
+ read-only text property have been added so it is not supposed to manipulate
+ the content but to add further text properties. For example, it is used by
+ the `org-transclusion-indent-mode' extension to support `org-indent-mode'.
+ The functions are called with arguments beg and end, pointing to the
+ beginning and end of the transcluded content.
+
+The hook also can be used to activate =org-latex-preview=:
+
+#+begin_src elisp
+ (add-hook 'org-transclusion-after-add-functions
+ #'(lambda (_beg _end) (org-latex-preview '(16))))
+#+end_src
+
** Customizable filter to exclude certain Org elements
:PROPERTIES:
:CUSTOM_ID: customizable-filter-to-exclude-certain-org-elements