From 028adf5cefe3344317a39dcde5d73cc530007a12 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 8 Dec 2015 12:22:45 +0100 Subject: structural improvements to the texinfo manual MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/info/reusable/macros.texinfo | 48 ++++++++++++++++ doc/info/reusable/paper.texinfo | 107 ++++++++++++++++++++++++++++++++++++ doc/info/reusable/titlepage.texinfo | 77 ++++++++++++++++++++++++++ 3 files changed, 232 insertions(+) create mode 100644 doc/info/reusable/macros.texinfo create mode 100644 doc/info/reusable/paper.texinfo create mode 100644 doc/info/reusable/titlepage.texinfo (limited to 'doc/info/reusable') diff --git a/doc/info/reusable/macros.texinfo b/doc/info/reusable/macros.texinfo new file mode 100644 index 0000000..8d95983 --- /dev/null +++ b/doc/info/reusable/macros.texinfo @@ -0,0 +1,48 @@ +@c GENERAL ADVICE. +@c Because of an previous regression bug in Texinfo +@c it is a good idea to use @w around lines using +@c macros. + + +@c Use this comment to get a good looking e-mail +@c address in both the info output and the TeX +@c processed output. +@iftex +@macro e{a} +(@email{\a\}) +@end macro +@end iftex +@ifnottex +@macro e{a} +@email{\a\} +@end macro +@end ifnottex + +@c This is intented do be used inside @example. +@c At the beginning of non-code text in a source +@c code comment, use this macro to make it look +@c good in TeX processed output. End with @xtt. +@iftex +@macro xrm{} +@rm{} +@end macro +@end iftex +@ifnottex +@macro xrm{} +@end macro +@end ifnottex + +@c This is intented do be used inside @example. +@c At the end of non-code text in a source code +@c comment, use this macro to make it look +@c good in TeX processed output. +@iftex +@macro xtt{} +@tt{} +@end macro +@end iftex +@ifnottex +@macro xtt{} +@end macro +@end ifnottex + diff --git a/doc/info/reusable/paper.texinfo b/doc/info/reusable/paper.texinfo new file mode 100644 index 0000000..1fc9f0f --- /dev/null +++ b/doc/info/reusable/paper.texinfo @@ -0,0 +1,107 @@ +@c This file is used, by inclusion, to allow the +@c builder to specify how output shall be formatted. + +@c On dead tree editions we defailt to smallbook format. +@ifset HARDCOPY +@ifclear USLETTER +@ifclear AFOURPAPER +@ifclear AFIVEPAPER +@ifclear SMALLBOOK +@set SMALLBOOK +@end ifclear +@end ifclear +@end ifclear +@end ifclear +@end ifset + +@c On dead tree editions the heading on the left page +@c is different from the heading on the right page. +@c On online editions the heading is identical on the +@c left pages and on the right pages. +@ifclear SINGLE_HEADINGS +@ifclear DOUBLE_HEADINGS +@ifclear HARDCOPY +@set SINGLE_HEADINGS +@end ifclear +@ifset HARDCOPY +@set DOUBLE_HEADINGS +@end ifset +@end ifclear +@end ifclear + +@c Apply paper format. Default to A4. (Remember +@c dead tree editions defaulted to smallbook.) +@ifset AFIVEPAPER +@afivepaper +@end ifset +@ifset SMALLBOOK +@smallbook +@end ifset +@ifclear AFIVEPAPER +@ifclear SMALLBOOK +@ifclear USLETTER +@afourpaper +@set AFOURPAPER +@end ifclear +@end ifclear +@end ifclear +@c (Texinfo defaults to US letter, thus nothing is +@c done for USLETTER.) + +@c Only on dead tree editions: optionally add +@c cropmarks, and by default, chapters begin +@c on odd page numbers (the right side.) +@ifset HARDCOPY +@ifset CROPMARKS +@cropmarks +@end ifset +@ifclear SKIPCHAPTERNEWPAGE +@setchapternewpage odd +@end ifclear +@end ifset + +@c Apply font size. On smallbook and A5 default to +@c 10 points, on A4 and US letter we default to +@c 11 points. +@ifclear SKIPFONTTEXTSIZE +@ifset SMALLBOOK +@set SMALLFONT +@end ifset +@ifset AFIVEPAPER +@set SMALLFONT +@end ifset +@end ifclear +@ifset SMALLFONT +@fonttextsize 10 +@end ifset +@ifclear SMALLFONT +@fonttextsize 11 +@end ifclear + +@c In America it is customary to have two spaces after +@c a period. It is not elsewhere. (@frenchspacing is a +@c misnomer) +@ifclear AMERICANSPACING +@frenchspacing on +@end ifclear + +@c This should only be used when writting the document. +@c It is used to locate overflows. It should be be used +@c in a printed version. It can be used in an online come +@c use users can easier detect overflows and report them. +@ifclear NOFINALOUT +@finalout +@end ifclear + + +@c Call this macro after the title page, but before the +@c table of content, or the short table of content. +@macro setheadings{} +@ifset DOUBLEHEADINGS +@headings double +@end ifset +@ifset SINGLEHEADINGS +@headings single +@end ifset +@end macro + diff --git a/doc/info/reusable/titlepage.texinfo b/doc/info/reusable/titlepage.texinfo new file mode 100644 index 0000000..0f3d553 --- /dev/null +++ b/doc/info/reusable/titlepage.texinfo @@ -0,0 +1,77 @@ +@c This file @top or @titlepage. + +@ifnottex +@node Top +@top @value{title} -- @value{subtitle} +@insertcopying +@end ifnottex + +@titlepage +@title @value{title} +@subtitle @value{subtitle} + +@c Date, edition, and version of the program. +@c Should be set on dead tree editions. Not too +@c important on online editions. +@ifset DATE +@ifset VERSION +@ifset EDITION +@subtitle @value{DATE}, @value{programname} version@tie{}@value{VERSION}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{DATE}, @value{programname} version@tie{}@value{VERSION} +@end ifclear +@end ifset +@ifclear VERSION +@ifset EDITION +@subtitle @value{DATE}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{DATE} +@end ifclear +@end ifclear +@end ifset +@ifclear DATE +@ifset VERSION +@ifset EDITION +@subtitle @value{programname} version@tie{}@value{VERSION}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{programname} version@tie{}@value{VERSION} +@end ifclear +@end ifset +@ifclear VERSION +@ifset EDITION +@subtitle @value{EDITION} edition +@end ifset +@end ifclear +@end ifclear + +@ifset LOGO +@vskip 0pt plus 1filll +@c This way, it is centered exactly in pdf and approximently +@c in dvi and ps. @center does not work for @image in dvi and ps. +@multitable @columnfractions 0.15 0.7 +@item @tab @center @image{../logo,250px} +@end multitable +@vskip 0pt plus 2filll +@end ifset +@authors{} + +@page +@ifset HARDCOPY +@vskip 0pt plus 1filll +@insertcopying +@page +@end ifset +@dedication{} +@ifclear HARDCOPY +@vskip 0pt plus 1filll +@ifset HARDCOPY_AVAILABLE +@orderhardcopy{} +@* +@end ifset +@insertcopying +@end ifclear +@end titlepage + -- cgit v1.2.3-70-g09d2