Difference between revisions of "wiki documentation"

From Lazarus wiki
(note)
Line 75: Line 75:
 
This will show as:
 
This will show as:
 
{{keypress|Ctrl}}+{{keypress|F12}}
 
{{keypress|Ctrl}}+{{keypress|F12}}
 +
 +
===Note===
 +
 +
To make text visible as note use template Note:
 +
 +
<pre>{{Note|This is note for reader}}</pre>
 +
 +
This will be displayed as
 +
{{Note|This is note for reader}}

Revision as of 12:23, 22 October 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 Template:keypress:

{{keypress|Ctrl}}+{{keypress|F12}}

This will show as: Ctrl+F12

Note

To make text visible as note use template Note:

{{Note|This is note for reader}}

This will be displayed as

Note-icon.png

Note: This is note for reader