From eefac897f92928aec04583f75ac6ecd243b9a982 Mon Sep 17 00:00:00 2001 From: simon Date: Tue, 20 Jan 2009 18:50:18 +0000 Subject: [PATCH] Fix missing docs for \cfg{paper-contents-indent-step} and \cfg{paper-contents-margin}. Also correct the spelling of the former. git-svn-id: svn://svn.tartarus.org/sgt/halibut@8424 cda61777-01e9-0310-a592-d414129be87e --- doc/index.but | 4 ++-- doc/output.but | 16 +++++++++++----- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/doc/index.but b/doc/index.but index 99e3a92..dae2951 100644 --- a/doc/index.but +++ b/doc/index.but @@ -453,8 +453,8 @@ directive \IM{\\cfg\{paper-rule-thickness\}} \c{paper-rule-thickness} configuration directive \IM{\\cfg\{paper-rule-thickness\}} \cw{\\cfg\{paper-rule-thickness\}} -\IM{\\cfg\{paper-contents-index-step\}} \c{paper-contents-index-step} configuration directive -\IM{\\cfg\{paper-contents-index-step\}} \cw{\\cfg\{paper-contents-index-step\}} +\IM{\\cfg\{paper-contents-indent-step\}} \c{paper-contents-indent-step} configuration directive +\IM{\\cfg\{paper-contents-indent-step\}} \cw{\\cfg\{paper-contents-indent-step\}} \IM{\\cfg\{paper-contents-margin\}} \c{paper-contents-margin} configuration directive \IM{\\cfg\{paper-contents-margin\}} \cw{\\cfg\{paper-contents-margin\}} diff --git a/doc/output.but b/doc/output.but index c9c287c..49a6b05 100644 --- a/doc/output.but +++ b/doc/output.but @@ -1687,13 +1687,19 @@ of section numbers (which are in the left margin). \S2{output-paper-index} Contents and index -\dt \I{\cw{\\cfg\{paper-contents-index-step\}}}\cw{\\cfg\{paper-contents-index-step\}\{}\e{points}\cw{\}} +\dt \I{\cw{\\cfg\{paper-contents-indent-step\}}}\cw{\\cfg\{paper-contents-indent-step\}\{}\e{points}\cw{\}} + +\dd Specifies by how much to indent each entry in the table of +contents per level of subdivision in the document. (In other words, +chapter titles appear at the left of the table of contents, headings +within the chapter are indented by the amount configured here, +subheadings by twice that, and so on.) \dt \I{\cw{\\cfg\{paper-contents-margin\}}}\cw{\\cfg\{paper-contents-margin\}\{}\e{points}\cw{\}} -\# FIXME: I do not know what dees one does. (I couldn't get either of -them to do anything obvious, although the source indicates they should -do something.) +\dd Specifies the amount of space on the right of the table of +contents which should be reserved for page numbers only. Headings in +the table of contents which extend into this space will be wrapped. \dt \I{\cw{\\cfg\{paper-leader-separation\}}}\cw{\\cfg\{paper-leader-separation\}\{}\e{points}\cw{\}} @@ -1855,7 +1861,7 @@ The default page size corresponds to 210\_\u00D7{x}\_297\_mm, i.e., \c \cfg{paper-chapter-underline-depth}{14} \c \cfg{paper-sect-num-left-space}{12} \c -\c \cfg{paper-contents-index-step}{24} +\c \cfg{paper-contents-indent-step}{24} \c \cfg{paper-contents-margin}{84} \c \cfg{paper-leader-separation}{12} \c \cfg{paper-footer-distance}{32} -- 2.11.0