|
|
(7 intermediate revisions by the same user not shown) |
Line 1: |
Line 1: |
− | LIKE EVERYTHING IN THIS SANDBOX, THIS IS ONLY A DRAFT AND SHOULD NOT BE USED YET.
| + | [[Introduction]] |
| | | |
− | | + | [[Some Basic Commands]] |
− | = ''start-stop'', ''setup'', and ''define'' =
| |
− | There are three main types of commands in ConTeXt:
| |
− | | |
− | # '''start-stop''': To apply ''something'' to some text, enclose the text in {{code|\start''something''}} {{code|\stop''something''}}.
| |
− | # '''setup''': To configure ''something'' for the rest of the document, use {{code|\setup''something''}}.
| |
− | # '''define''': To create a named customization of ''something'', use {{code|\define''something''}}.
| |
− | | |
− | Many commands don’t fit into one of these types, but here are some that do. Throughout this list {{code|start''something''}} is shorthand for {{code|start''something''}} {{code|stop''something''}}.
| |
− | | |
− | == Structure ==
| |
− | These commands relate to the structure of a document.
| |
− | | |
− | * {{cmd|starttext}}: In a typical document, the text to be typeset is enclosed by this. {{cmd|definetext}} and {{cmd|setuptext}} are defined but have little documentation and don’t appear to be used much.
| |
− | * {{cmd|startdocument}} and {{cmd|setupdocument}}: If customization is wanted, the text to be typeset can be enclosed by {{cmd|startdocument}} instead of {{cmd|starttext}}. The command {{cmd|startdocument}} allows for document metadata and can be configured with {{cmd|setupdocument}}.
| |
− | * {{cmd|definehead} and {{cmd|setuphead}}: The generic name for a section of a document in ''head'', so these commands allow you to define and customize your own sections. The main built-in sections are: part, chapter, section, subsection, subsubsection, and their numberless counterparts. See the [[Titles]] page for further details.
| |
− | * {{cmd|setupheader}}/{{cmd|setupfooter}}: These can be used to customize the headers and footers of a document, including whether or not anything should be displayed in them.
| |
− | * {{cmd|setupheadertexts}}/{{cmd|setupfootertexts}}: If the headers and footers are set to display text, these commands allow you to customize what those texts are.
| |
− | * {{cmd|definemakeup}}, {{cmd|setupmakeup}}, and {{cmd|startmakeup}}: A ''makeup'' is a page with a different formatting than the rest of the pages in the document (such as a title page or colophon). Use these commands to make and customize the formatting of such a page.
| |
− | * {{cmd|definesectionblock}} and {{cmd|setupsectionblock}}: A ''section block'' is a section of the document with its own page numbering format (such as the built-in section blocks {{code|frontpart}}, {{code|bodypart}}, {{code|backpart}}, and {{code|appendix}}). You can use these commands to define and customize section blocks.
| |
− | * {{cmd|definestartstop}} and {{cmd|setupstartstop}}: Use these commands to define and customize your own ''start-stop'' regions.
| |
− | * {{cmd|setupblock}} and {{cmd|setupblock}}: Use these commands to define and customize your own formats for blocks of text. These are somewhat similar to ''start-stop'' regions, but there is one major difference: there commands such as {{cmd|hideblocks}} to turn off the display of blocks. For other such commands, see the documentation for {{cmd|setupblock}}.
| |
− | * {{cmd|definelist}} and {{cmd|setuplist}}: Use these to define and customize your own types of lists.
| |
− | * {{cmd|definelistalternative}} and {{cmd|setuplistalternative}}: These commands allow you to define and customize options for the {{code|alternative}} key in {{cmd|setuplist}}.
| |
− | * {{cmd|definedescription}} and {{cmd|setupdescription}}: With these commands, you can define and customize your own ''descriptions''. For more details about descriptions, see the [[Description]] page.
| |
− | * {{cmd|definecombinedlist}} and {{cmd|setupcombinedlist}}: Use these to define and custsomize combined lists. A ''combined list'' is a generalization of the table of contents. See the [[Table of contents]] page for further details.
| |
− | * {{cmd|definepagebreak}}: This allows you to define a configuration for page breaks, as used in many different commands (including {{cmd|pagebreak}} and {{cmd|page}}.
| |
− | | |
− | == Text formatting and decoration ==
| |
− | These commands relate to how text is displayed, without repositioning the text (much).
| |
− | | |
− | * {{cmd|definehighlight}} and {{cmd|setuphighlight}}
| |
− | * {{cmd|defineframed}}, {{cmd|setupframed}}, and {{cmd|startframed}}
| |
− | * {{cmd|defineframedtext}} and {{cmd|setupframedtext}}
| |
− | * {{cmd|definemathframed}} and {{cmd|setupmathframed}}
| |
− | * {{cmd|defineblank}} and {{cmd|setupblank}}
| |
− | * {{cmd|definehspace}} and {{cmd|setuphspace}}
| |
− | * {{cmd|setupwhitespace}}
| |
− | * {{cmd|setupinterlinespace}}
| |
− | * {{cmd|definelines}} and {{cmd|setuplines}}
| |
− | * {{cmd|definetyping}} and {{cmd|setuptyping}}
| |
− | * {{cmd|definetype}} and {{cmd|setuptype}}
| |
− | | |
− | == Layout and Design ==
| |
− | These commands relate to how text is laid out on the page, and possibly involve moving or positioning the text.
| |
− | | |
− | * {{cmd|definepapersize}} and {{cmd|setuppapersize}}
| |
− | * {{cmd|definelayout}} and {{cmd|setuplayout}}
| |
− | * {{cmd|setuppagenumbering}}
| |
− | * {{cmd|definelayer}} and {{cmd|setuplayer}}
| |
− | * {{cmd|definecolor}} and {{cmd|setupcolors}}
| |
− | * {{cmd|definecolorgroup}}
| |
− | * {{cmd|definepalet}} and {{cmd|setuppalet}}
| |
− | * {{cmd|defineoverlay}}
| |
− | * {{cmd|definecombination}} and {{cmd|setupcombination}}
| |
− | | |
− | | |
− | == Utilities ==
| |
− | These commands have various functions that don’t relate directly to text formatting and design.
| |
− | | |
− | * {{cmd|defineconversion}} and {{cmd|convertnumber}}
| |
− | * {{cmd|setupscale}} and {{cmd|scale}}
| |
− | * {{cmd|definemode}}
| |