Browse Source

Factor out setup for doc

* doc/doc-setup.org: New file.
* doc/org-guide.org:
* doc/org-manual.org: Use new file.
Nicolas Goaziou 1 month ago
parent
commit
d588274878
3 changed files with 39 additions and 61 deletions
  1. 36 0
      doc/doc-setup.org
  2. 1 27
      doc/org-guide.org
  3. 2 34
      doc/org-manual.org

+ 36 - 0
doc/doc-setup.org

@@ -0,0 +1,36 @@
+# SETUPFILE for manuals
+
+# XXX: We cannot use TODO keyword as a node starts with "TODO".
+#+todo: REVIEW FIXME | DONE
+#+property: header-args :eval no
+#+startup: overview nologdone
+
+# Use proper quote and backtick for code sections in PDF output
+# Cf. Texinfo manual 14.2
+#+texinfo_header: @set txicodequoteundirected
+#+texinfo_header: @set txicodequotebacktick
+
+# Contact Info
+#+texinfo_header: @set MAINTAINERSITE @uref{https://orgmode.org,maintainers webpage}
+#+texinfo_header: @set MAINTAINER Carsten Dominik
+#+texinfo_header: @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
+#+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
+
+#+options: H:4 num:t toc:t author:t \n:nil ::t |:t ^:nil -:t f:t *:t <:t e:t ':t
+#+options: d:nil todo:nil pri:nil tags:not-in-toc stat:nil broken-links:mark
+#+select_tags: export
+#+exclude_tags: noexport
+
+#+macro: cite @@texinfo:@cite{@@$1@@texinfo:}@@
+#+macro: var @@texinfo:@var{@@$1@@texinfo:}@@
+
+# The "version" macro extracts "Version" keyword from "org.el".  It
+# returns major.minor version number.  This is sufficient since bugfix
+# releases are not expected to add features and therefore imply manual
+# modifications.
+#+macro: version (eval (with-current-buffer (find-file-noselect "../lisp/org.el") (org-with-point-at 1 (if (re-search-forward "Version: +\\([0-9.]+\\)" nil t) (mapconcat #'identity (cl-subseq (split-string (match-string-no-properties 1) "\\.") 0 2) ".") (error "Missing \"Version\" keyword in \"org.el\"")))))
+
+# The "kbd" macro turns KBD into @kbd{KBD}.  Additionnally, it
+# encloses case-sensitive special keys (SPC, RET...) within @key{...}.
+#+macro: kbd (eval (let ((case-fold-search nil) (regexp (regexp-opt '("SPC" "RET" "LFD" "TAB" "BS" "ESC" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words))) (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (replace-regexp-in-string regexp "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t))))
+

+ 1 - 27
doc/org-guide.org

@@ -2593,10 +2593,7 @@ support in a file, use
 
 * Export Setup                                                          :noexport:
 
- # XXX: We cannot use TODO keyword as a node starts with "TODO".
-#+todo: REVIEW FIXME | DONE
-#+property: header-args :eval no
-#+startup: overview nologdone
+#+setupfile: doc-setup.org
 
 #+export_file_name: orgguide.texi
 
@@ -2604,29 +2601,6 @@ support in a file, use
 #+texinfo_dir_title: Org Guide: (orgguide)
 #+texinfo_dir_desc: Abbreviated Org mode manual
 
-# Use proper quote and backtick for code sections in PDF output
-# Cf. Texinfo manual 14.2
-#+texinfo_header: @set txicodequoteundirected
-#+texinfo_header: @set txicodequotebacktick
-
-#+options: H:4 num:t toc:t author:t \n:nil ::t |:t ^:nil -:t f:t *:t <:t e:t ':t
-#+options: d:nil todo:nil pri:nil tags:not-in-toc stat:nil broken-links:mark
-#+select_tags: export
-#+exclude_tags: noexport
-
-#+macro: cite @@texinfo:@cite{@@$1@@texinfo:}@@
-#+macro: var @@texinfo:@var{@@$1@@texinfo:}@@
-
-# The "version" macro extracts "Version" keyword from "org.el".  It
-# returns major.minor version number.  This is sufficient since bugfix
-# releases are not expected to add features and therefore imply manual
-# modifications.
-#+macro: version (eval (with-current-buffer (find-file-noselect "../lisp/org.el") (org-with-point-at 1 (if (re-search-forward "Version: +\\([0-9.]+\\)" nil t) (mapconcat #'identity (cl-subseq (split-string (match-string-no-properties 1) "\\.") 0 2) ".") (error "Missing \"Version\" keyword in \"org.el\"")))))
-
-# The "kbd" macro turns KBD into @kbd{KBD}.  Additionnally, it
-# encloses case-sensitive special keys (SPC, RET...) within @key{...}.
-#+macro: kbd (eval (let ((case-fold-search nil) (regexp (regexp-opt '("SPC" "RET" "LFD" "TAB" "BS" "ESC" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words))) (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (replace-regexp-in-string regexp "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t))))
-
 * Footnotes
 
 [fn:1] See the variable ~org-special-ctrl-a/e~ to configure special

+ 2 - 34
doc/org-manual.org

@@ -20893,46 +20893,14 @@ modify this GNU manual."
 
 * Export Setup                                                          :noexport:
 
-# XXX: We cannot use TODO keyword as a node starts with "TODO".
-#+todo: REVIEW FIXME | DONE
-#+property: header-args :eval no
-#+startup: overview nologdone
+#+setupfile: doc-setup.org
 
 #+export_file_name: org.texi
 
-#+texinfo_dir_category: Emacs editing modes
+#+texinfo_dir_category: Emacs
 #+texinfo_dir_title: Org Mode: (org)
 #+texinfo_dir_desc: Outline-based notes management and organizer
 
-# Use proper quote and backtick for code sections in PDF output
-# Cf. Texinfo manual 14.2
-#+texinfo_header: @set txicodequoteundirected
-#+texinfo_header: @set txicodequotebacktick
-
-# Contact Info
-#+texinfo_header: @set MAINTAINERSITE @uref{https://orgmode.org,maintainers webpage}
-#+texinfo_header: @set MAINTAINER Carsten Dominik
-#+texinfo_header: @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
-#+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
-
-#+options: H:4 num:t toc:t author:t \n:nil ::t |:t ^:nil -:t f:t *:t <:t e:t ':t
-#+options: d:nil todo:nil pri:nil tags:not-in-toc stat:nil broken-links:mark
-#+select_tags: export
-#+exclude_tags: noexport
-
-#+macro: cite @@texinfo:@cite{@@$1@@texinfo:}@@
-#+macro: var @@texinfo:@var{@@$1@@texinfo:}@@
-
-# The "version" macro extracts "Version" keyword from "org.el".  It
-# returns major.minor version number.  This is sufficient since bugfix
-# releases are not expected to add features and therefore imply manual
-# modifications.
-#+macro: version (eval (with-current-buffer (find-file-noselect "../lisp/org.el") (org-with-point-at 1 (if (re-search-forward "Version: +\\([0-9.]+\\)" nil t) (mapconcat #'identity (cl-subseq (split-string (match-string-no-properties 1) "\\.") 0 2) ".") (error "Missing \"Version\" keyword in \"org.el\"")))))
-
-# The "kbd" macro turns KBD into @kbd{KBD}.  Additionnally, it
-# encloses case-sensitive special keys (SPC, RET...) within @key{...}.
-#+macro: kbd (eval (let ((case-fold-search nil) (regexp (regexp-opt '("SPC" "RET" "LFD" "TAB" "BS" "ESC" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words))) (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (replace-regexp-in-string regexp "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t))))
-
 * Footnotes
 
 [fn:1] If you do not use Font Lock globally turn it on in Org buffer