[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/toc-org d30b57f16d 077/128: Merge pull request #40 from al
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/toc-org d30b57f16d 077/128: Merge pull request #40 from alphapapa/update-primary-docstring |
Date: |
Sun, 2 Jan 2022 09:59:11 -0500 (EST) |
branch: elpa/toc-org
commit d30b57f16d158fa859b0626f5350520f3ee86f44
Merge: f0b94e07bb a3d953a5fa
Author: Sergei Nosov <sergei.nosov@gmail.com>
Commit: GitHub <noreply@github.com>
Merge pull request #40 from alphapapa/update-primary-docstring
Update and clarify primary docstring to explain :noexport:, etc.
---
toc-org.el | 37 ++++++++++++++++++++++---------------
1 file changed, 22 insertions(+), 15 deletions(-)
diff --git a/toc-org.el b/toc-org.el
index 8ca32899be..18263ceffe 100644
--- a/toc-org.el
+++ b/toc-org.el
@@ -294,26 +294,33 @@ each heading into a link."
(point-min) (point-max))))
(defun toc-org-insert-toc (&optional dry-run)
- "Looks for a headline with the TOC tag and updates it with the
-current table of contents.
+ "Update table of contents in heading tagged :TOC:.
-If optional second argument DRY-RUN is provided, then the buffer
-is not modified at all. Only the internal hash-table is updated
-to enable `org-open-at-point' for TOC links.
+When DRY-RUN is non-nil, the buffer is not modified, only the
+internal hash-table is updated to enable `org-open-at-point' for
+TOC links.
-To add a TOC tag, you can use the command
-`org-set-tags-command' (C-c C-q).
+The table of contents heading may also be set with these tags:
-In addition to the simple :TOC: tag, you can also use the
-following tag formats:
+- :TOC_#: Sets the maximum depth of the headlines in the table of
+ contents to the number given, e.g. :TOC_3: for
+ 3 (default for plain :TOC: tag is 2).
-- :TOC_2: - sets the max depth of the headlines in the table of
- contents to 2 (the default)
+- :TOC_#_gh: Sets the maximum depth as above and also uses
+ GitHub-style anchors in the table of contents (the
+ default). The other supported style is :TOC_#_org:,
+ which is the default org style.
-- :TOC_2_gh: - sets the max depth as in above and also uses the
- GitHub-style hrefs in the table of contents (this style is
- default). The other supported href style is 'org', which is the
- default org style."
+Headings may be excluded from the TOC with these tags:
+
+- :noexport: Exclude this heading.
+
+- :noexport_#: Exclude this heading's children with relative
+ level greater than number given (e.g. :noexport_1:
+ causes all child headings to be excluded).
+
+Note that :noexport: is also used by Org-mode's exporter, but
+not :noexport_#:."
(interactive)
(when (eq major-mode 'org-mode)
- [nongnu] elpa/toc-org 2c4ff18a4e 092/128: document quote functionality, (continued)
- [nongnu] elpa/toc-org 2c4ff18a4e 092/128: document quote functionality, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org 4315afd2a4 095/128: fix readme, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org cf4a624b78 122/128: Add license file with GPLv3, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org 2539b4be40 097/128: add test for parenthesis in custom TODO words declaration, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org f13f79737a 020/128: Wrap test call with `(eval-after-load "ert-autoloads"...), ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org e9cf57041a 008/128: fix heading regexp, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org abbcb67166 011/128: allow _ as seprartor, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org ad3424d457 067/128: move tests to a separate file, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org 5a8a3f9b3a 080/128: Merge pull request #42 from snosov1/remove-opening-space, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org aa52bd036d 071/128: handle headlines with COMMENT, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org d30b57f16d 077/128: Merge pull request #40 from alphapapa/update-primary-docstring,
ELPA Syncer <=
- [nongnu] elpa/toc-org 37f3bf2733 112/128: Add tests for the case-sensitive COMMENT regexp, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org 4d259c9cea 086/128: Merge pull request #51 from snosov1/work-in-derived-modes, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org cd1868787c 087/128: Fix Emacs 26 warning, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org 3315ef6c96 106/128: Merge pull request #66 from snosov1/enable-toc-org-for-markdown, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org 9fefa63d42 119/128: Merge pull request #75 from Alexander-Miller/local-offset, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org 7ff7abb015 029/128: update documentation on org-toc-2 in the source, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org df4ad6ff15 121/128: Merge pull request #76 from snosov1/revert-75-local-offset, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org c4c61c5a38 117/128: Merge pull request #73 from syohex/correct-sample, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org acca680bc5 098/128: Add somewhat working TOC generation for markdown files, ELPA Syncer, 2022/01/02
- [nongnu] elpa/toc-org 0b759818ee 025/128: fix byte-compilation warning, ELPA Syncer, 2022/01/02