Difference between revisions of "Help:Context"
Jump to navigation
Jump to search
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
The <code><nowiki><context> ... </context></nowiki></code> tags process their ConTeXt contents on the fly and include the result on the page as an image. Whitespace is cropped out. The following attributes may be set: | The <code><nowiki><context> ... </context></nowiki></code> tags process their ConTeXt contents on the fly and include the result on the page as an image. Whitespace is cropped out. The following attributes may be set: | ||
| − | * <code>source=yes</code> displays the source before the output. | + | * <code>source="yes"</code> displays the source before the output. |
* <code>text="some text"</code> places 'some text' between the source and the output. | * <code>text="some text"</code> places 'some text' between the source and the output. | ||
| − | * <code>mode=mkiv</code> | + | * <code>mode="mkiv"</code> forces [[Mark IV]] instead of the default [[LMTX]] (should not be needed except to demonstrate a documented difference) |
| + | * <code>force="yes"</code> forces regeneration of the PNG image each time the page is loaded. This is expensive, so please only use it on special occasions (like in the example below where we are showing the {{cmd|contextbanner}}. | ||
Quotation marks around attribute strings are only required if the attribute contains non-alphabetic characters. | Quotation marks around attribute strings are only required if the attribute contains non-alphabetic characters. | ||
| − | + | The extension wraps your code with a bit of extra ConTeXt code to get a compilable file. There are two different | |
| − | + | cases, depending on whether your code contains {{cmd|starttext}} ... {{cmd|stoptext}} or not. | |
| + | With a starttext/stoptext block, the wrapping uses: | ||
| + | |||
| + | <texcode> | ||
| + | \setuppapersize[A5][A5] | ||
| + | \setupexternalfigures[location={local,default}] | ||
| + | \setupbodyfont[8pt] | ||
| + | \setupcolors[state=start] | ||
| + | .. your input here .. | ||
| + | </texcode> | ||
| + | |||
| + | and without starttext/stoptext, the extension uses: | ||
| + | |||
| + | <texcode> | ||
| + | \setuppapersize[A5][A5] | ||
| + | \setupexternalfigures[location={local,default}] | ||
| + | \setupbodyfont[8pt] | ||
| + | \setupcolors[state=start] | ||
| + | \starttext | ||
| + | \startTEXpage | ||
| + | .. your input here .. | ||
| + | \stopTEXpage | ||
| + | \stoptext | ||
| + | </texcode> | ||
| + | |||
== Examples == | == Examples == | ||
| Line 34: | Line 59: | ||
|} | |} | ||
| − | === source=yes === | + | === source="yes" === |
{| class=wikitable | {| class=wikitable | ||
| Line 56: | Line 81: | ||
|} | |} | ||
| − | === mode= | + | === mode="mkiv" and mode="lmtx" === |
| − | By default, the wiki compiles examples using | + | By default, the wiki compiles examples using [[LMTX]]. You can specify that you want to use MkIV by adding the option <tt>mode="mkiv"</tt> to the tag. Because MkIV examples are visually indistinguishable from LMTX examples, it is good practice to start MkIV examples with a comment <code>% mode=mkiv</code>. |
{| class=wikitable | {| class=wikitable | ||
| Line 64: | Line 89: | ||
|- style="vertical-align: top" | |- style="vertical-align: top" | ||
| <xmlcode> | | <xmlcode> | ||
| − | <context source=yes> | + | <context source="yes" force="yes"> |
| − | + | \contextbanner | |
| − | |||
</context> | </context> | ||
</xmlcode> | </xmlcode> | ||
| − | | <context source=yes> | + | | <context source="yes" force="yes"> |
| − | + | \contextbanner | |
</context> | </context> | ||
|- style="vertical-align: top" | |- style="vertical-align: top" | ||
| <xmlcode> | | <xmlcode> | ||
| − | <context mode=mkiv source=yes> | + | <context mode="mkiv" source="yes" force="yes"> |
| − | % mode = mkiv | + | % mode=mkiv |
| − | + | \contextbanner | |
</context> | </context> | ||
</xmlcode> | </xmlcode> | ||
| − | |<context mode=mkiv source=yes> | + | |<context mode="mkiv" source="yes" force="yes"> |
| − | % mode = mkiv | + | % mode=mkiv |
| − | + | \contextbanner | |
</context> | </context> | ||
|} | |} | ||
| Line 87: | Line 111: | ||
=== Displaying multiple pages === | === Displaying multiple pages === | ||
| − | <context source=yes> | + | <context source="yes"> |
\setuppapersize[A10, landscape][A8, landscape] | \setuppapersize[A10, landscape][A8, landscape] | ||
| Line 104: | Line 128: | ||
[[Category:Help|Context]] | [[Category:Help|Context]] | ||
| − | + | [[Category:Wiki-Maintenance]] | |
Revision as of 12:37, 28 October 2021
The <context> ... </context> tags process their ConTeXt contents on the fly and include the result on the page as an image. Whitespace is cropped out. The following attributes may be set:
source="yes"displays the source before the output.text="some text"places 'some text' between the source and the output.mode="mkiv"forces Mark IV instead of the default LMTX (should not be needed except to demonstrate a documented difference)force="yes"forces regeneration of the PNG image each time the page is loaded. This is expensive, so please only use it on special occasions (like in the example below where we are showing the \contextbanner.
Quotation marks around attribute strings are only required if the attribute contains non-alphabetic characters.
The extension wraps your code with a bit of extra ConTeXt code to get a compilable file. There are two different cases, depending on whether your code contains \starttext ... \stoptext or not.
With a starttext/stoptext block, the wrapping uses:
\setuppapersize[A5][A5] \setupexternalfigures[location={local,default}] \setupbodyfont[8pt] \setupcolors[state=start] .. your input here ..
and without starttext/stoptext, the extension uses:
\setuppapersize[A5][A5] \setupexternalfigures[location={local,default}] \setupbodyfont[8pt] \setupcolors[state=start] \starttext \startTEXpage .. your input here .. \stopTEXpage \stoptext
Contents
Examples
Plain example
| Wiki markup | Wiki display |
|---|---|
<context> \setupcolors [state=start] \framed [background=color, backgroundcolor=gray, offset=0.5cm ]{hello world!} </context> |
|
source="yes"
| Wiki markup | Wiki display |
|---|---|
<context source="yes" text="produces"> \setupcolors [state=start] \framed [background=color, backgroundcolor=gray, offset=0,5cm ]{hello world!} </context> |
\setupcolors [state=start] \framed [background=color, backgroundcolor=gray, offset=0.5cm ]{hello world!} produces
|
mode="mkiv" and mode="lmtx"
By default, the wiki compiles examples using LMTX. You can specify that you want to use MkIV by adding the option mode="mkiv" to the tag. Because MkIV examples are visually indistinguishable from LMTX examples, it is good practice to start MkIV examples with a comment % mode=mkiv.
| Wiki markup | Wiki display |
|---|---|
<context source="yes" force="yes"> \contextbanner </context> |
\contextbanner
internal error: copy error /var/www/contextgarden.net/wiki/htdocs/wikiteximage/6da8f59c9f3d6e0b26c62e5611fb685e.png
|
<context mode="mkiv" source="yes" force="yes"> % mode=mkiv \contextbanner </context> |
% mode=mkiv \contextbannerinternal error: copy error /var/www/contextgarden.net/wiki/htdocs/wikiteximage/27c67e9609eaa5415620ba1b1fcc363a.png |
Displaying multiple pages
\setuppapersize[A10, landscape][A8, landscape] \setuppaper[nx=2, ny=2] % arrange pages 2 by 2 (must come before \setuparranging[XY]) \setuparranging[XY] % arrange pages n by n (across, then down) \setuppagenumbering[location=footer] % page numbers are always useful \showframe[edge] % Draw line around each page. Prevents overzealous cropping one \page[yes] two \page[yes] three \page[yes] four
| ||||||||||||||||||||
