branch: externals/doc-toc
commit 8c2cb1283dab98966f3cca4f97daaeb2764d20b8
Author: Daniel Nicolai <dalanico...@gmail.com>
Commit: Daniel Nicolai <dalanico...@gmail.com>
Add info about pdf.tocgen alternative
---
.github/FUNDING.yml | 1 +
README.org | 9 +++++++++
toc-mode.el | 5 +++++
3 files changed, 15 insertions(+)
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000000..9bc0a864de
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1 @@
+custom:
"https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6BHLS7H9ARJXE&source=url";
diff --git a/README.org b/README.org
index c2e347e7dd..39962063e0 100644
--- a/README.org
+++ b/README.org
@@ -32,6 +32,15 @@ line utility to be available.
* Usage
+For 'software-generated' (i.e. PDF's not created from scans) PDF-files I
+recommend to use [[https://krasjet.com/voice/pdf.tocgen/][pdf.tocgen]] instead
of =toc-mode= (although the pdf.tocgen
+functionality might get integrated into =toc-mode= soon).
+
+In each step below, check out available shortcuts using =C-h m=. Additionally
you
+can find available functions by typing the M-x mode-name (e.g. =M-x
toc-cleanup=),
+or with two dashes in the mode name (e.g. =M-x toc--cleanup=). Of course if you
+use packages like Ivy or Helm you just use the fuzzy search functionality.
+
Extraction and adding contents to a document is done in 4 steps:
1. extraction
2. cleanup
diff --git a/toc-mode.el b/toc-mode.el
index e514172daf..6aee05f762 100644
--- a/toc-mode.el
+++ b/toc-mode.el
@@ -41,6 +41,11 @@
;; Usage:
+;; For 'software-generated' (i.e. PDF's not created from scans) PDF-files I
+;; recommend to use pdf.tocgen (see URL
`https://krasjet.com/voice/pdf.tocgen/')
+;; instead of `toc-mode' (although the pdf.tocgen functionality might get
+;; integrated into =toc-mode= soon).
+
;; In each step below, check out available shortcuts using C-h m. Additionally
;; you can find available functions by typing the M-x mode-name (e.g. M-x
;; toc-cleanup), or with two dashes in the mode name (e.g. M-x toc--cleanup).
Of
