3,897
edits
Changes
Jump to navigation
Jump to search
< [[The ConTeXt Way]] | [[Structurals]] >=Introduction=
==Introduction==ConTeXt knows no document classes (as LaTeX does). You can define your [[Layout|layout]] yourself.
ConTeXt knows no document classes (as LaTeX does). You can define your [[Layout|layout]] yourself. If you use the same layout for several products, save it as an '''environment''' file.
==File and directory setup==
===Naming conventions===
===Example files===
\startproject project_mymag
\product tableofcontent
\startproduct prd_year2004-01
\startcomponent c_editorial
===Subdirectories===
==Command behaviour==
==See also== Hans Hagen (2011) [http://pragma-ade.com/general/magazines/mag-1101.pdf Project Structure], ConTeXt magazine #1101.
Hans Hagen (2011) [http[Category://pragma-ade.com/general/magazines/mag-1101.pdf Project StructureBasics]][[Category:Tools]], ConTEXt magazine #1101.
no edit summary
:<i><b>Note</b>: the project structure explained on this page is not the only way to handle complex documents. If you are working on a project with a single output file, it may be simpler to use {{cmd|startdocument}} (perhaps in combination with {{cmd|usemodule}} or {{cmd|environment}} and {{cmd|startcomponent}} as explained below) and ignore the elaborate project and product setups.</i> If you use the same layout for several related products, it may make sense to use the project support in ConTeXt. You then save your layout settings as an '''environment''' file, and you can reuse various document parts in multiple products. How to split up a large project, say a bookcollection of books, in several handy parts? – Use ConTeXt's project management facilities.
* a '''project''' links one or more '''products''' to their environment
If you tex (compile) one single component (e.g. a chapter of a book) or product (e.g. one volume of a magazine), the environment file of the project is used.
In addition, you have to keep in mind that when compiling a product or component file, ConTeXt goes "up" to the project file and compiles everything it finds in there that is not a {{cmd|product}} (e.g. table of content, sectioning commands, text, {{cmd|component}} etc.). So all the things on project level have to be put inside a {{cmd|product}}, otherwise they will show up in the individual components (or products), too. That also makes it problematic to use {{cmd|component}} directly inside a project file, i.e. you '''have ''' to use {{cmd|product}}, you can't skip it. While you can compile ("tex") products and single components, the project is not intended for compiling; trying might lead to infinite inclusion loops and the error message "TeX capacity exceeded".
[[User:Hraban|Hraban]] uses and suggests the following naming conventions
There's a Python script <tt>contextproject.py</tt> at Hraban's [http://github.com/fiee/tools/blob/master/contextproject.py github repository] to help creating the files (.ini files can be used for initial content). This functionality would be nice to be integrated in any editor supporting ConTeXt...
'''Project'''
<texcode>
\startproject project_mymag
\environment env_mymag % only mentioned here!
\product prd_year2004-01
\product prd_year2004-03
\product prd_year2004-04
\stopproject
'''Product'''
<texcode>
\startproduct prd_year2004-01
\project project_mymag
\component c_editorial
'''Component'''
<texcode>
\project project_mymagstartcomponent c_editorial
\product prd_year2004-01 % but you can use it in other products anyway
\title{Editorial}
</texcode>
If you keep all files in one directory, it tends to get confusing. Here’s a structured example where we keep all parts of one product together:
ConTeXt automatically looks into parent directories.
Within a <code>\start...\stop...</code> environment, project, product, and environment definition files are loaded only once, while component files are loaded at every mention. In addition, certain loading commands are ignored inside certain environments -- for example, it makes no sense to load a <code>\component</code> inside a <code>\startenvironment</code> block. The table below gives an overview.
|}
