Template:Pre2/doc

From Foundry Wiki
Template-info.png Documentation

Usage

  • {{Pre|1= |background= |color= |width= |space= }}

All parameters are optional:

  • |1= – the text to present (may include markup and templates to expand; note that automatic syntaxhighliting is not supported; the default text is empty).
  • |background= |color= – set alternate colors (in CSS format) to use for distinguighing status of the rendered code: bad, non-working, obsolete, deprecated, unsupported, discouraged, simplified, incomplete, tricky, detailed, supported, recommended, advanced, optional, mandatory, current, future, proposal, untested, beta, approved, rejected, dangerous, problematic, temporary, workaround, alternative, etc.; for passing CSS colors using a compact numeric format starting with a sharp sign # followed by hexadecimal digits (3 or 6 digits for RGB colors, 4 or 8 digits for RGBA colors), you may need to escape it by a leading <nowiki/> empty tag, so that it won't be interpreted by MediaWiki as a numbered list item when it preprocesses parameters given to the template, or use a template generating the color syntax.
  • |width= – CSS width for the generated <pre></pre> parent element (useful in table cells).
  • |space= – one of the values accepted for the CSS white-space: attribute (pre-wrap by default to preserve newlines in the text given in 1st parameter but still allow wrapping overlong lines, without overflowing the width or using an horizontal scrollbar)

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.