Difference between revisions of "wiki documentation"
(→Guide to Wiki Editing: Removed note about changing highlighter in future versions. The future version has become the current version now.) |
|||
Line 1: | Line 1: | ||
== Guide to Wiki Editing == | == Guide to Wiki Editing == | ||
+ | |||
=== Overview === | === Overview === | ||
+ | |||
Tutorials | Tutorials | ||
* [http://www.chat11.com/30_Second_Quick_Wiki_Tutorial 30 Second Quick Wiki Tutorial] | * [http://www.chat11.com/30_Second_Quick_Wiki_Tutorial 30 Second Quick Wiki Tutorial] | ||
Line 10: | Line 12: | ||
=== Syntax Highlighting === | === Syntax Highlighting === | ||
+ | |||
A Wiki for a programming language site needs a powerful way of showing source code in readable fashion. Therefore we use an automatic syntax highlighter to for sources. Use the "<source>" or "<syntaxhighlight> tag for FPC code. Delphi language is the default highlighter language. For a list of supported languages see the [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages highlighter docs]. For XML code, use <syntaxhighlight lang="xml">. The following example shows the use of the syntax highlighter in this Wiki: | A Wiki for a programming language site needs a powerful way of showing source code in readable fashion. Therefore we use an automatic syntax highlighter to for sources. Use the "<source>" or "<syntaxhighlight> tag for FPC code. Delphi language is the default highlighter language. For a list of supported languages see the [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages highlighter docs]. For XML code, use <syntaxhighlight lang="xml">. The following example shows the use of the syntax highlighter in this Wiki: | ||
<pre> | <pre> | ||
Line 62: | Line 65: | ||
For program output or other verbatim quotes please use the "<pre>" and "</pre>" tags. | For program output or other verbatim quotes please use the "<pre>" and "</pre>" tags. | ||
+ | |||
+ | ===Keyboard shortcuts=== | ||
+ | |||
+ | To display keyboard shortcuts use template keypress: | ||
+ | <pre> | ||
+ | {{keypress|Ctrl}}+{{keypress|F12}} | ||
+ | </pre> | ||
+ | |||
+ | This will show as: | ||
+ | {{keypress|Ctrl}}+{{keypress|F12}} |
Revision as of 13:11, 15 April 2012
Guide to Wiki Editing
Overview
Tutorials
A Sand Box is available for practice.
If you have any problems, please notify the site administrator or post a bug report on the Lazarus-CCR SF site. You can also leave a note or suggestion on our Site Feedback page.
Syntax Highlighting
A Wiki for a programming language site needs a powerful way of showing source code in readable fashion. Therefore we use an automatic syntax highlighter to for sources. Use the "<source>" or "<syntaxhighlight> tag for FPC code. Delphi language is the default highlighter language. For a list of supported languages see the highlighter docs. For XML code, use <syntaxhighlight lang="xml">. The following example shows the use of the syntax highlighter in this Wiki:
<source> Program Test; Uses Crt; Var I : Integer; Begin For I := 0 to 12 do WriteLn('Test ',I:2); End. </source>
results in this output
Program Test;
Uses Crt;
Var I : Integer;
Begin
For I := 0 to 12 do
WriteLn('Test ',I:2);
End.
Below is an example for XML sources.
<syntaxhighlight lang="xml"> <xs:complexType name="DecimalWithUnits"> <xs:simpleContent> <xs:extension base="xs:decimal"> <xs:attribute name="Units" type="xs:string" use="required"/> </xs:extension> </xs:simpleContent> </xs:complexType> </syntaxhighlight>
results in
<xs:complexType name="DecimalWithUnits">
<xs:simpleContent>
<xs:extension base="xs:decimal">
<xs:attribute name="Units" type="xs:string"
use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
For program output or other verbatim quotes please use the "<pre>" and "</pre>" tags.
Keyboard shortcuts
To display keyboard shortcuts use template keypress:
{{keypress|Ctrl}}+{{keypress|F12}}
This will show as: Ctrl+F12