User Tools

Site Tools


contributing

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
contributing [2025/03/04 13:33] โ€“ [Contributing] finished sentence karelkubicekcontributing [2026/09/17 07:22] (current) โ€“ Markup rendering sweep: wrap escapes, CLI flag typography, and heading quotes. Authored by Claude. karel.kubicek.claude
Line 62: Line 62:
 === Code === === Code ===
  
-For short inline monospace, use ''double quotes''. For proper code (in a separate paragraph), use ''<code LANG>'':+For short inline monospace, use ''double quotes''. For proper code (in a separate paragraph), use ''%%<code LANG>%%'':
  
   <code python>   <code python>
Line 68: Line 68:
   </code>   </code>
  
-For large code, use ''<file LANG filename>''; this will make the code downloadable. For instance:+For large code, use ''%%<file LANG filename>%%''; this will make the code downloadable. For instance:
  
 <code> <code>
Line 81: Line 81:
 print('Hello world!') print('Hello world!')
 </file> </file>
 +
 +=== Boxes ===
 +
 +Notes, warnings and open-question boxes use the **uppercase** ''<nowiki><WRAP></nowiki>'' tag, which renders a ''<nowiki><div></nowiki>'':
 +
 +  <WRAP todo>
 +  Paragraphs, lists and tables can all go inside a box like this.
 +  </WRAP>
 +
 +The lowercase ''<nowiki><wrap></nowiki>'' renders a ''<nowiki><span></nowiki>'' instead. A span cannot contain block content, so a lowercase box holding more than a few words of running text is silently mangled โ€” the page renders wrong without any error. **Always use uppercase.** If a box holds a bullet list, put the whole list inside one box rather than opening a box per bullet.
  
 === Figures === === Figures ===
contributing.1741095239.txt.gz ยท Last modified: by karelkubicek