Difference between revisions of "Visual Debugging"
(→[[Fonts]] and Type: some examples added (but perhaps the page is now too long)) |
m (category Old Content) |
||
(16 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
− | < [[ | + | Page is focused on the old [[Mark_II|Mark II]] ConTeXt version, though <tt>\show...</tt> commands are still the same. Work-in-progress page on current [[LMTX]] version is [[Debugging]]. |
− | There's a whole lot of commands that help you analyzing and debugging your ConTeXt documents. Most of them start with | + | |
+ | |||
+ | There's a whole lot of commands that help you analyzing and debugging your ConTeXt documents. Most of them start with {{cmd|show...}} or {{cmd|trace...}}. While {{cmd|showsomething}} is a command that immediately inserts something, {{cmd|tracesomethingtrue}} or ...<tt>false</tt> is a switch that influences the behaviour of some other commands. You can check the setting with {{cmd|iftrace...}}. In the following we leave out the boolean value (true or false). | ||
==Unordered== | ==Unordered== | ||
− | + | {{cmd|tracefiles}} : ? | |
− | + | {{cmd|tracepositions}} : ? | |
− | + | {{cmd|traceposstring}} : ? | |
− | + | {{cmd|traceboxplacement}} : ? | |
− | + | {{cmd|traceotr}} : output routine? | |
+ | |||
+ | {{cmd|showboxes}} : show boxes | ||
==[[Layout]]== | ==[[Layout]]== | ||
− | + | {{cmd|showlayout}} : add four pages that show margins, layout sizes etc. | |
+ | |||
+ | {{cmd|showsetups}} : typeset a list of all defined sizes (variables) and their values | ||
+ | |||
+ | {{cmd|showmakeup}} : show some otherwise invisible markup | ||
+ | |||
+ | {{cmd|showframe}} : show frames of text area, layers, boxes etc. | ||
+ | |||
+ | {{cmd|showlayoutcomponents}} : To allow Acrobat Reader users (among others?) to make layers visible/invisible at will, add this command at the start of your file. | ||
+ | |||
+ | ===Show attributes of visual elements=== | ||
+ | |||
+ | <texcode> | ||
+ | \usemodule [setups] | ||
+ | |||
+ | \starttext | ||
− | + | % \setuphead [..,..=..,..] | |
+ | \showrootvalues [head] | ||
− | + | % \setuphead [chapter] [..,..=..,..] | |
+ | \showinstancevalues [head] [chapter] | ||
− | + | \stoptext | |
+ | </texcode> | ||
===Grid, Layers and Column Sets=== | ===Grid, Layers and Column Sets=== | ||
− | + | {{cmd|tracelayers}} : show boxes of layers | |
− | + | {{cmd|tracecolumnset}} : ? | |
− | + | {{cmd|tracetextareas}} : ? | |
− | + | {{cmd|showgrid}} : make line grid visible | |
− | + | {{cmd|tracegridsnapping}} : ? | |
===[[Tables Overview|Tables]]=== | ===[[Tables Overview|Tables]]=== | ||
− | + | {{cmd|tracetables}} : ? | |
− | + | {{cmd|traceTABLE}} : ? | |
− | + | {{cmd|tracetabulate}} : ? | |
==[[Math]]== | ==[[Math]]== | ||
− | + | {{cmd|tracemathtrue}} : show the layout boxes for left, middle, or right-aligned formulas. | |
− | + | {{cmd|tracemathcommand}} : ? | |
− | + | {{cmd|tracemathcollection}} : ? | |
− | + | {{cmd|tracemathsymbol}}''{name of math symbol}'' : show the command (name of symbol) and the symbol itself | |
− | < | + | <texcode> |
+ | \tracemathcollectiontrue | ||
+ | \tracemathsymbol{Re} | ||
+ | \tracemathsymbol{Im} | ||
+ | </texcode> | ||
+ | <context> | ||
+ | \tracemathcollectiontrue | ||
+ | \tracemathsymbol{Re} | ||
+ | \tracemathsymbol{Im} | ||
+ | </context> | ||
+ | {{cmd|tracemathcharacter}} : ? | ||
==[[Bookmarks]] and [[References]]== | ==[[Bookmarks]] and [[References]]== | ||
− | + | {{cmd|tracebookmarks}} : ? | |
− | + | {{cmd|tracelinenotes}} : ? | |
− | + | {{cmd|tracereferences}} : ? | |
− | + | {{cmd|tracelabels}} : ? | |
− | == | + | == Fonts and Type== |
− | + | {{cmd|showbodyfont}} : actual bodyfont family with all variants | |
<context> | <context> | ||
Line 79: | Line 111: | ||
</context> | </context> | ||
− | + | {{cmd|showbodyfontenvironment}} : draws a table that shows which point sizes match the relative sizes | |
+ | |||
<context> | <context> | ||
\setuplayout[scale=.7] | \setuplayout[scale=.7] | ||
Line 85: | Line 118: | ||
</context> | </context> | ||
− | + | {{cmd|showsymbolset}}[''symbolset name''] : shows all the symbols within a given symbol set | |
<texcode> | <texcode> | ||
Line 95: | Line 128: | ||
</context> | </context> | ||
− | + | {{cmd|showcharacters}} : list of available chars of actual bodyfont encoding (approx. 4 pages, MkII only) | |
<context> | <context> | ||
Line 103: | Line 136: | ||
</context> | </context> | ||
− | + | {{cmd|showmathcharacters}} : list of all the available math (non-alphabetical) characters available in math, now including all the AMS characters. MkII only | |
<context> | <context> | ||
Line 111: | Line 144: | ||
</context> | </context> | ||
− | + | {{cmd|showaccents}} : shows A-Z and a-z with all available accents, MkII only | |
<context> | <context> | ||
Line 119: | Line 152: | ||
</context> | </context> | ||
− | + | {{cmd|showstruts}} : display struts (invisible placeholders for proper minimum line heights) | |
''(Make a better, slightly more complex example.)'' | ''(Make a better, slightly more complex example.)'' | ||
Line 141: | Line 174: | ||
− | + | {{cmd|showfontstrip}} : the current typeface combination, with roman, sans, math, and teletype families visualised, with x-heights | |
<context> | <context> | ||
Line 148: | Line 181: | ||
</context> | </context> | ||
− | + | {{cmd|tracefonthandling}} : | |
− | + | {{cmd|tracechinese}} : ? | |
− | + | {{cmd|tracedfontname}}''{Font Name}'' : Chain of synonyms for the given font name | |
<texcode> | <texcode> | ||
Line 163: | Line 196: | ||
</context> | </context> | ||
− | + | {{cmd|tracedfontencoding}} : ? | |
− | == | + | == Colors and Graphics == |
===Colors=== | ===Colors=== | ||
− | + | {{cmd|showcolor}} : see [[Color]] | |
− | + | {{cmd|showcolorgroup}} : ? | |
− | + | {{cmd|showpalet}} : ? | |
− | + | {{cmd|tracedgreymode}} : ? | |
− | + | {{cmd|tracedgreycolormode}} : ? | |
− | + | {{cmd|tracedrgbcolormode}} : ? | |
− | + | {{cmd|tracedcmykcolormode}} : ? | |
− | + | {{cmd|tracedspotcolormode}} : ? | |
===Figures=== | ===Figures=== | ||
− | + | {{cmd|showexternalfigures}} : ? | |
− | + | {{cmd|traceexternalfigures}} : ? | |
− | + | {{cmd|tracesidefloats}} : ? | |
===Interaction=== | ===Interaction=== | ||
− | + | {{cmd|showfields}} : ? | |
+ | |||
+ | {{cmd|tracefields}} : ? | ||
+ | |||
+ | {{cmd|traceJScode}} : trace JavaScript code | ||
+ | |||
− | + | {{todo|A lot of commands and switches are still unexplained.}} | |
− | + | [[Category:Basics]] | |
+ | [[Category:Tools]] | ||
+ | [[Category:Layout]] | ||
+ | [[Category:Old Content]] |
Latest revision as of 11:05, 9 February 2021
Page is focused on the old Mark II ConTeXt version, though \show... commands are still the same. Work-in-progress page on current LMTX version is Debugging.
There's a whole lot of commands that help you analyzing and debugging your ConTeXt documents. Most of them start with \show... or \trace.... While \showsomething is a command that immediately inserts something, \tracesomethingtrue or ...false is a switch that influences the behaviour of some other commands. You can check the setting with \iftrace.... In the following we leave out the boolean value (true or false).
Unordered
\tracefiles : ?
\tracepositions : ?
\traceposstring : ?
\traceotr : output routine?
\showboxes : show boxes
Layout
\showlayout : add four pages that show margins, layout sizes etc.
\showsetups : typeset a list of all defined sizes (variables) and their values
\showmakeup : show some otherwise invisible markup
\showframe : show frames of text area, layers, boxes etc.
\showlayoutcomponents : To allow Acrobat Reader users (among others?) to make layers visible/invisible at will, add this command at the start of your file.
Show attributes of visual elements
\usemodule [setups] \starttext % \setuphead [..,..=..,..] \showrootvalues [head] % \setuphead [chapter] [..,..=..,..] \showinstancevalues [head] [chapter] \stoptext
Grid, Layers and Column Sets
\tracelayers : show boxes of layers
\tracecolumnset : ?
\tracetextareas : ?
\showgrid : make line grid visible
Tables
\tracetables : ?
\traceTABLE : ?
\tracetabulate : ?
Math
\tracemathtrue : show the layout boxes for left, middle, or right-aligned formulas.
\tracemathsymbol{name of math symbol} : show the command (name of symbol) and the symbol itself
\tracemathcollectiontrue \tracemathsymbol{Re} \tracemathsymbol{Im}
Bookmarks and References
Fonts and Type
\showbodyfont : actual bodyfont family with all variants
\showbodyfontenvironment : draws a table that shows which point sizes match the relative sizes
\showsymbolset[symbolset name] : shows all the symbols within a given symbol set
\showsymbolset[navigation 1]
\showcharacters : list of available chars of actual bodyfont encoding (approx. 4 pages, MkII only)
\showmathcharacters : list of all the available math (non-alphabetical) characters available in math, now including all the AMS characters. MkII only
\showaccents : shows A-Z and a-z with all available accents, MkII only
\showstruts : display struts (invisible placeholders for proper minimum line heights)
(Make a better, slightly more complex example.)
\setupframed[framecolor=gray] \showstruts This will display \strut struts.\crlf Frame with struts: \framed{xxx}\crlf And frame without them: \framed[strut=no]{xxx}
\showfontstrip : the current typeface combination, with roman, sans, math, and teletype families visualised, with x-heights
\tracechinese : ?
\tracedfontname{Font Name} : Chain of synonyms for the given font name
\tracedfontname{Bold}
Colors and Graphics
Colors
\showcolor : see Color
\showcolorgroup : ?
\showpalet : ?
\tracedgreymode : ?
Figures
\tracesidefloats : ?
Interaction
\showfields : ?
\tracefields : ?
\traceJScode : trace JavaScript code
|
TODO: A lot of commands and switches are still unexplained. (See: To-Do List) |