This documentation is transcluded from Template:Created with code/doc.
| 👁 Image | This documentation is unclear and incomplete. It should be reviewed. |
Parameters for display of codes
Usage
{{Created with code |code= }}
{{Cwcode|… parameters as described …}}
This is mainly a subtemplate of Image generation, but can also be used in stand-alone mode.
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
codecode1 c1 | code | the source code used for image generation may not contain |, || ,[[ or }} (replace by {{!}}, {{!!}}, {{!((}} or {{))}} resp., or embed everything in <nowiki>…</nowiki>)The alias c4= can be used directly from Image generation.[clarification needed] | empty | optional |
titletitle1 h1 | title | headline to be shown above the code (see #title} use title=none to suppress the headline | syntaxsyntax1l1 | optional |
syntaxsyntax1 l1 | syntax | one of the supported languages for highlighting | text | optional |
formatformat1 f1 | style | style attribute for code display 1st colors are and | empty | optional |
collapsecollapse1 s1 | text | headline to be shown instead of the code if collapsed to disable standard collapsing use s1=none | empty | optional |
code2c2 | code | 2nd source code for image generation may not contain |, || ,[[ or }} (see code1) | empty | optional |
title2h2 | title | headline for 2nd source code ("none" for suppress) | syntax2l2 | optional |
syntax2l2 | syntax | one of the supported languages for highlighting | text | optional |
format2f2 | style | style attribute for 2nd code display 2nd colors are and | empty | optional |
collapse2s2 | text | headline to be shown instead of the 2nd code if collapsed | empty | optional |
code3c3 | code | 3rd source code for image generation may not contain |, || ,[[ or }} (see code1) | empty | optional |
title3h3 | title | headline for 3rd source code ("none" for suppress) | syntax3l3 | optional |
l3syntax3 | syntax | one of the supported languages for highlighting | text | optional |
format3f3 | style | style attribute for 3rd code display 3rd colors are and | empty | optional |
collapse3s3 | text | headline to be shown instead of the 3rd code if collapsed | 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=-
The string " code" is inserted between the toolname and the subcategory,
it looks like:
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 code/code1/c1 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 See the SVG code in the File:Test.svg.
with suppression of the categorizing.
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>…</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 syntax is not 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 followed by " code", like every other headline text, but that display of " code" can be suppressed when the headline text starts with "_", or with "<nowiki/> " (the tag "<nowiki/>" followed by a slash).
- l - syntax
- Specifies the language of the source code to be highlighted. Some templates preset code (and code2, code3) with languages as default values, but not Setswana: Created with codeitself.
- The defaults can be overwritten. When using as subtemplate adding of
syntax=text(syntax2, syntax3) 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%[clarification needed]; 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.[clarification needed]
- + - name
- defines a name, esp. for
Other fieldsof {{Information}}.
Example
{{ Created with code | code1 = first code example | syntax1 = python
| code2 = second code example | syntax2 = matlab | title2 = second | e2 = :There is a second code following
| code3 = textual data | syntax3 = text | title3 = _third | collapse3 = hidden data | e3 = :The third code is hidden: | n3 = finis. | format3 = background-color:#FFA }} will display
Python
first code example
- There is a second code following
Second code
secondcodeexample
- The third code is hidden:
third
| hidden data |
|---|
textual data |
Note: This template is used on a lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum. Please discuss proposed changes on the talk page first.
|
