Template:Code/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>DragonHawk
explain nowiki effects
meta>AoV2
doc
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
Wraps a short span of text in {{tag|code}} tags.  This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|source}}.  See [[Help:Wiki markup]] for an explaination of what the various tags do.
Wraps a short span of text in {{tag|code}} tags.  This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|source}}.  See [[Help:Wiki markup]] for an explanation of what the various tags do.


If the content includes an equals sign (=), you must specify the parameter explicitly: <code><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>.
If the content includes an equals sign (=), you must specify the parameter explicitly: <code><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>.
Line 14: Line 14:


This template does not need to be [[Wikipedia:Template substitution|substituted]].
This template does not need to be [[Wikipedia:Template substitution|substituted]].
Use parameter {{{2}}}/{{{lang}}} to specify language for syntax highlighting.
===Examples===
{| class="wikitable" style="font-family:serif;"
|-
| <pre style="margin:0px; white-space:normal;">Lorem {{code|ipsum dolor}} sit amet</pre>
| Lorem {{code|ipsum dolor}} sit amet
|-
| <pre style="margin:0px; white-space:normal;">The declaration {{code|lang=cpp|int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.</pre>
| The declaration {{code|lang=cpp|int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.
|}


=== See also ===
=== See also ===

Revision as of 02:34, 8 March 2010

Wraps a short span of text in <code>...</code> tags. This template should be used for short samples; longer content should use <pre>...</pre> or <source>...</source>. See Help:Wiki markup for an explanation of what the various tags do.

If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.

The template uses the {{nowiki}} tag to attempt to supress wiki markup interpretation. This works on some things, but not others. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:

<syntaxhighlight lang="text" class="" id="" style="" inline="1">some wiki text</syntaxhighlight>

However, {{code|a {{template}} call}} will still invoke the template:

<syntaxhighlight lang="text" class="" id="" style="" inline="1">a {{[[Template:{{{1}}}|{{{1}}}]]}} call</syntaxhighlight>

This template does not need to be substituted.

Use parameter {{{2}}}/{{{lang}}} to specify language for syntax highlighting.

Examples

Lorem {{code|ipsum dolor}} sit amet
Lorem <syntaxhighlight lang="text" class="" id="" style="" inline="1">ipsum dolor</syntaxhighlight> sit amet
The declaration {{code|lang=cpp|int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.
The declaration <syntaxhighlight lang="cpp" class="" id="" style="" inline="1">int foo(const std::string& bar, const std::vector<long double*>& baz);</syntaxhighlight> is the prototype for a function defined later.

See also