Template:Created with code
Parameters for display of codes
Usage
{{Created with code |c1= }}
This is a mainly subtemplate of Image generation, but can also be used in stand-alone mode.
When used directly, the following restrictions apply:
- ● The subtemplate itself accepts only the short form of parameters (c1, c2, c3; h1, h2, h3; ...), see Example
By the template {{Image generation}} the short forms as well as the long forms (e.g. c1 = code = source) are accepted and passed, even mixed.
Can also be used with c4= (instead of c1= but continued with d1, e1, f1, h1, l1, n1, s1)
Template parameters
Parameter | Description | Default | Status | |
---|---|---|---|---|
c1 code source script | code | the source code used for image generation may not contain |, || ,[[ or }} (replace by {{!}}, {{!!}}, {{!((}} or {{))}} resp.) The alias c4= can be used directly from Image generation | empty | optional |
h1 title | title | headline to be shown above the code (see #title} use title=none to suppress the headline | l1 source | optional |
l1 syntax | syntax | one of the supported languages for highlighting | text | optional |
f1 format | style | style attribute for code display 1st colors are #AFA and #DFD | empty | optional |
s1 collapse | text | headline to be shown instead of the code to disable standard collapsing use s1=none | empty | optional |
code2 c2 | code | 2nd source code for image generation may not contain |, || ,[[ or }} | empty | optional |
title2 h2 | title | headline for 2nd source code ("none" for suppress) | l2 data | optional |
syntax2 l2 | syntax | one of the supported languages for highlighting | text | optional |
format2 f2 | style | style attribute for 2nd code display 2nd colors are #DFA and #FEE | empty | optional |
collapse2 s2 | text | headline to be shown instead of the 2nd code | empty | optional |
c3 code3 | code | 3rd source code for image generation may not contain |, || ,[[ or }} | empty | optional |
h3 title3 | title | headline for 3rd source code ("none" for suppress) | l3 text | optional |
l3 syntax3 | syntax | one of the supported languages for highlighting | text | optional |
f3 format3 | style | style attribute for 3rd code display 3rd colors are #FFA and #EEB | empty | optional |
s3 collapse3 | text | headline to be shown instead of the 3rd code | empty | optional |
d1, d2, d3 | diff_cat | categorizes "Images with dx source code" | empty | optional |
e1, e2, e3 | explanation | explanatory text to be shown above the code | empty | optional |
g1, g2, g3 | grandeur | font sizes for code display (when other than 100%) | 100 | optional |
n1, n2, n3 | note | footing note after codex (within the border) | empty | optional |
+ | name | (+c in Igen) create a name as an Information field | Source code | optional |
nt | switch | when specified (even empty) avoids hx interpretion as headings | empty | optional |
cc | switch | when specified (even empty) the categorization is suppressed | empty | optional |
Additional information
The template is intended to be used in the following namespaces: the Template namespace
The template is intended to be used by the following user groups: all users
Categorizing
occurs normally centralized by Image generation where it always can be suppressed with the parameter "cc":
cc=
, cc=n
,cc=-
Th string " code" is inserted between the toolname and the subcategory,
it looks like: Valid/Invalid SVG created with toolcat
codesubcat
Depending on the defined categories, often either code or subcat can be used, and the other one needs to be suppressed.
External code
For the c1
/code
parameter the special value external
can be used, instead of a code block a line is displayed with the value of parameter e1
to show that the code is contained elsewhere:
external
|e1=See the SVG code in the {{F|Test.svg|+}}.
displays Parameters
- c - code
- Because the source code is passed as a parameter value, characters or combinations as |, [[, }} may not appear within the source code; such characters or combinations must be enclosed in <nowiki> or substituted to avoid preliminary termination or breaking of the execution.
- When e.g.
<!--
should be shown, it can be done with {{ Charsubst | < }}!--
to avoid misinterpretion.
- e - expl
- may specify any text, wiki syntax or other content; precedes the block with the code
- h - title
-
- the default value for a title is "
syntax
code"; - when no syntax is specified, defaults are "Source code", "Data code" and "Text code";
- every text string can be used to title the code, but
- "none" can be used to suppress any titling, e.g. when the source code is collapsed.
- Any text string is always followed by " code", like every other headline text;
- that display of " code" can be suppressed when the headline text starts with "_", or with "<nowiki/> " (the tag "<nowiki/>" followed by a space).
- the default value for a title is "
- l - syntax
- specifies the language of the source code to be highlighted. Some templates preset code (and code2, code3) with languages as default values,
- the defaults can be overwritten. Using of
syntax=text
suppresses any highlighting.
- f - format
- With this parameter values of the
<div style="clear:both;border:1px solid#AFE;background-color:#EFE;margin:2px 0;">
can be altered or completed. The three codes use different border and background colors, #AFE/#EFE, #DFA/#FEE and #FFA/#EEB. - g - greatness
- another font size than 100%; can as well be specified with
|fx=font-size:xxx%
- s - collapse
- defines a text string; when that parameter is used, the text string is shown instead of the collapsed source code.
- n - note
- defines a text string; will be displayed at the bottom of the code box.
- d - diffusion
- defines a text string for category diffusion within Images including source code in their description.
- + - name
- defines a name, esp. for
Other fields
of Information.
Example
{{ Created with code | c1 = first code example | l1 = python
| c2 = second code example | l2 = matlab | h2 = second | e2 = :There is a second code following
| c3 = textual data | l3 = text | h3 = _third | s3 = hidden data | e3 = :The third code is hidden: | n3 = finis. | f3 = background-color:#FFA }} will display
Python code
first code example
- There is a second code following
Second code
second code example
- The third code is hidden:
third
hidden data |
---|
textual data
|