GNU Texinfo Reference Card @Contents Print a Complete Table of Contents

GNU Texinfo Reference Card @Contents Print a Complete Table of Contents

GNU Texinfo Reference Card @contents Print a complete table of contents. Has no effect in Cross references (for Texinfo version 6.8) Info, which uses menus instead. Within the Info system http://www.gnu.org/software/texinfo/ Nodes @xref {node, [entry] , [node-title] , [info-file] , [manual] } Makes @node name Begin a new node. a reference that starts with ‘See’ in a printed manual. Follow Texinfo document skeleton command with punctuation. Only the first argument is @top title Mark the topmost @node in the file, which must be mandatory. Texinfo source files are plain text; standard extensions are defined on the line immediately preceding @top. The title is @pxref {node, [entry] , [node-title] , [info-file] , [manual] } Like ‘.texinfo’, ‘.texi’, and ‘.txi’. A Texinfo file must begin with formatted as a chapter-level heading. The entire top node, @xref, but starts with ‘see’ instead of ‘See’, and must be used lines like this: including the @node and @top lines, are normally enclosed with @ifnottex ... @end ifnottex. inside parentheses. \input texinfo @ref {node, [entry] , [node-title] , [info-file] , [manual] } Like @xref, @settitle name-of-manual @anchor {name} Define name as the current location, for use as a cross-reference target. but produces only the bare reference without ‘See’ or ‘see’; must ... be followed by a punctuation mark. the contents of the Texinfo document, ending with: @novalidate Suppress validation of node references and omit @bye creation of auxiliary files with T X. Use before @setfilename. @xrefautomaticsectiontitle on|off By default, use the section E title instead of the node name in cross references. Texinfo @-commands Chapter structuring Outside of Info Beginning a Texinfo document @lowersections Change subsequent chapters to sections, sections @url {url, [displayed-text] , [replacement] } Make a hyperlink to subsections, and so on. The commands in this section are given approximately in the reference to a uniform resource locator. @uref is a synonym. @raisesections order in which they conventionally appear. Change subsequent sections to chapters, @cite {title} Indicate the name of a book or other reference that subsections to sections, and so on. has no Info file; no hyperlink. @setfilename info-file-name Provide a name to be used for the @part title Print part page, beginning a group of chapters; output files. included in contents. Marking text @settitle title Specify document title. Numbered, included in contents Markup for regular text @copying @end Specify copyright and licensing text. Pair with @abbr {abbreviation} Indicate a general abbreviation, such as copying. @chapter title Begin a numbered chapter; title appears in the table of contents. ‘Comput.’ @insertcopying Insert text defined by @copying. Context-dependent, included in contents @acronym {acronym} Indicate an acronym written in all capital Internationalization letters, such as ‘NASA’. @section title Begin a section within a chapter. Within @chapter @documentencoding enc Declare the input encoding to be enc; use and @appendix, the section is numbered; within @unnumbered, it is @dfn {term} Indicate the introductory or defining use of a right after @setfilename. Default is US-ASCII; other possibilities: unnumbered. technical term. UTF-8, ISO-8859-1, koi8-r, ... @subsection title Begin a subsection within a section. Same @emph {text} Emphasize text, by using italics where possible, and @documentlanguage LL[_CC] Declare the current language as the context-dependent numbering as @section. enclosing in asterisks in Info. two-character ISO-639 abbreviation LL, optionally followed by @subsubsection title @strong {text} Emphasize text even more strongly, by using bold an underscore and a two-letter ISO 3166 two-letter country code Begin a numbered subsubsection within a subsection. Same context-dependent numbering as @section. where possible; still enclosed in asterisks in Info. (CC). Default is en_US. @sub {text} Set text as a subscript. Unnumbered, included in contents @frenchspacing on|off Control spacing after punctuation. @sup {text} Set text as a superscript. @unnumbered title Begin an unnumbered chapter. Info directory specifications @var {metasyntactic-variable} Indicate a meta variable (a name @unnumberedsec title @dircategory category name Specify an Info directory section Begin an unnumbered section. that stands for another piece of text). @unnumberedsubsec title Begin an unnumbered subsection. for this file’s entries. Can be repeated. We try to follow the Markup for literal text categories in the Free Software Directory. @unnumberedsubsubsec title Begin an unnumbered subsubsection. @code {sample-code} @direntry Begin the Info directory menu entries for this file. Pair Indicate an expression, a syntactically Lettered and numbered, included in contents complete token, or a program name. Unquoted in Info output. with @end direntry. @appendix title Begin an appendix. @command {command-name} Indicate a system command name, HTML document description @appendixsec title Begin an appendix section within an appendix; such as ls. @appendixsection @documentdescription Set the document description text for is a synonym. @email {address, [displayed-text] } Indicate an email address. HTML @appendixsubsec title ; default is just the title of the document. Pair with @end Begin an appendix subsection; @env {environment-variable} Indicate an environment variable @appendixsubsection is a synonym. documentdescription. name, such as PATH. @appendixsubsubsec title Begin an appendix subsubsection; Title pages @file {filename} Indicate the name of a file, buffer, node, @appendixsubsubsection is a synonym. @shorttitlepage title Generate a minimal title page, generally for directory, etc. the first page of output in a long printed manual. Unnumbered, not in contents, no new page @indicateurl {url} Indicate a uniform resource locator, but @center line-of-text Center line-of-text, usually for titles. @chapheading title Print an unnumbered chapter-like heading. without creating any hyperlink. @titlefont {text} In a printed manual, print text in a larger than @majorheading title Like @chapheading, but generate additional @kbd {keyboard-characters} Indicate characters of input to be normal font. Ignored in Info. vertical whitespace before the heading. typed by users. @titlepage Begin the title page. Write the command on a line of @heading title Print an unnumbered section-like heading. @key {key-name} Indicate the name of a key on a keyboard. its own, paired with @end titlepage. Ignored in Info. @subheading title Print an unnumbered subsection-like heading. @option {option-name} Indicate a command-line option, such as @title title Within @titlepage, display title appropriately. @subsubheading title Print an unnumbered subsubsection-like -v and --help. @subtitle subtitle Within @titlepage, display subtitle. heading. @samp {text} Indicate a sequence of literal characters, in general. @author author Within @titlepage, display author. Menus Quoted in Info output. Tables of contents @verb {delimchar literal-text delimchar} Output literal-text, @menu Mark the beginning of a menu of nodes in Info. No effect delimited by the single character delimchar, exactly as is, @shortcontents Print a short table of contents (chapter-level in a printed manual. Pair with @end menu. including any whitespace or Texinfo special characters. Example: entries only). Not relevant to Info. @detailmenu Mark the (optional) detailed node listing in a master @verb{|@ @}|}. @summarycontents Synonym for @shortcontents. menu. GUI sequences @smallformat Like @format, but select a smaller (text) font where @image {filename, [width] , [height] , [alt] , [ext] } Include graphics @arrow {} Insert a right arrow glyph, →. possible. Pair with @end smallformat. image in external filename scaled to the given width and/or @clicksequence {action @click{} action ... } Represent a @flushleft Left justify lines, leaving the right end ragged: do height, using alt text and looking for ‘filename.ext’ first. Can sequence of GUI actions or clicks. not fill text, retain normal margins and normal text font. Pair occur inline or by itself on the page. @click {} Represent a single ‘click’ in a @clicksequence. with @end flushleft. Footnotes @clickstyle @cmd Execute @cmd for each @click; default is @flushright Right justify lines, leaving the left end ragged: do @footnote {text-of-footnote} Insert a footnote: text-of-footnote is not fill text, retain normal margins and normal text font. Pair @arrow. Empty braces usually following @cmd are omitted here. printed at the bottom of the page by TEX, while Info and others with @end flushright. Math may format at either (by default) the end of the current node, or Displays using fixed-width fonts in a separate node. @math {math} Format the given math (inline); \ becomes an In these environments also, each line of input is a line of output. @footnotestyle style Specify footnote style: ‘end’ or ‘separate’. escape character, and all plain TEX math is available. @displaymath Create a display math environment. Pair with @end @example Begin an example. Indent text, do not fill, and select Indices displaymath. fixed-width font. Pair with @end example. @cindex entry Add entry to the index of concepts. @minus {} Insert a minus sign, ‘−’. @smallexample Like @example, but where possible, print text in a @findex entry Add entry to the index of functions. @\ Inside @math, insert a math backslash, \. smaller font. Pair with @end smallexample. @kindex entry Add entry to the index of keys. @geq {} Insert a greater-than-or-equal

View Full Text

Details

  • File Type
    pdf
  • Upload Time
    -
  • Content Languages
    English
  • Upload User
    Anonymous/Not logged-in
  • File Pages
    4 Page
  • File Size
    -

Download

Channel Download Status
Express Download Enable

Copyright

We respect the copyrights and intellectual property rights of all users. All uploaded documents are either original works of the uploader or authorized works of the rightful owners.

  • Not to be reproduced or distributed without explicit permission.
  • Not used for commercial purposes outside of approved use cases.
  • Not used to infringe on the rights of the original creators.
  • If you believe any content infringes your copyright, please contact us immediately.

Support

For help with questions, suggestions, or problems, please contact us