doc/doc-setup.org

   1 # SETUPFILE for manuals
   2
   3 # XXX: We cannot use TODO keyword as a node starts with "TODO".
   4 #+todo: REVIEW FIXME | DONE
   5 #+property: header-args :eval no
   6 #+startup: overview nologdone
   7
   8 # Use proper quote and backtick for code sections in PDF output
   9 # Cf. Texinfo manual 14.2
  10 #+texinfo_header: @set txicodequoteundirected
  11 #+texinfo_header: @set txicodequotebacktick
  12
  13 # Contact Info
  14 #+texinfo_header: @set MAINTAINERSITE @uref{https://orgmode.org,maintainers webpage}
  15 #+texinfo_header: @set MAINTAINER Carsten Dominik
  16 #+texinfo_header: @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  17 #+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  18
  19 #+options: H:4 num:t toc:t author:t \n:nil ::t |:t ^:nil -:t f:t *:t <:t e:t ':t
  20 #+options: d:nil todo:nil pri:nil tags:not-in-toc stat:nil broken-links:mark
  21 #+select_tags: export
  22 #+exclude_tags: noexport
  23
  24 #+macro: cite @@texinfo:@cite{@@$1@@texinfo:}@@
  25 #+macro: var @@texinfo:@var{@@$1@@texinfo:}@@
  26
  27 # The "version" macro extracts "Version" keyword from "org.el".  It
  28 # returns major.minor version number.  This is sufficient since bugfix
  29 # releases are not expected to add features and therefore imply manual
  30 # modifications.
  31 #+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\"")))))
  32
  33 # The "kbd" macro turns KBD into @kbd{KBD}.  Additionnally, it
  34 # encloses case-sensitive special keys (SPC, RET...) within @key{...}.
  35 #+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))))
  36