Claus chr: Corrected links

2012-09-09T10:37:57Z

Corrected links

Claus chr at 08:31, 2 September 2012

2012-09-02T08:31:24Z

Claus chr at 09:08, 1 September 2012

2012-09-01T09:08:47Z

Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase

2012-09-01T08:47:34Z

1 revision: Moving Docbook Primer from UserBase to TechBase

Annew: Marked this version for translation

2011-11-30T15:48:46Z

Marked this version for translation

New page

<translate>

=== The synopsis elements === 

</translate><translate>

{{Tag|cmdsynopsis}}


:'''Example: How to markup a command synopsis'''


:{{Input|1=<nowiki>
<cmdsynopsis>
<command>more</command>
<group choice="opt"><option>-d</option>
<option>l</option><option>f</option>
<option>p</option><option>c</option>
<option>s</option><option>u</option>
</group>
<arg>-num</arg>
<arg>+/ pattern</arg>
<arg>+ linenum</arg>
<arg rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</nowiki>}}


:This should generate:


:<code>more [-dlfpcsu][-'''''num'''''][+/ '''''pattern'''''][+ '''''linenum''''']['''''file''''']</code>


There are several very nice examples in the Duck book at [http://www.docbook.org www.docbook.org]

</translate><translate>

{{Tag|funcsynopsis}}


:'''Example: How to markup a function synopsis'''


:{{Input|1=<nowiki>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>setFile</function></funcdef>
<paramdef>QString <parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>


<funcsynopsis>
<funcprototype>
<funcdef>void <function>setAutoResize</function></funcdef>
<paramdef>bool <parameter><replaceable>val</replaceable></parameter></paramdef>
</funcprototype>
</funcsynopsis>


<funcsynopsis>
<funcprototype>
<funcdef>QString <function>getVideoCodec</function></funcdef><void/>
</funcprototype>
</funcsynopsis>
</nowiki>}}


:These would generate the following, respectively.


:<tt>void '''setFile'''(''file''); QString file;</tt>


:<tt>void '''setAutoResize'''(''val''); bool val;</tt>


:<tt>QString '''getVideoCodec'''();</tt>


:A function synopsis can contain the following:

</translate><translate>


:{{Tag|funcprototype}}


::Contains a prototype of the function. It can contain {{Tag|void}}, {{Tag|varargs}}, {{Tag|paramdef}} or most commonly, a {{Tag|funcdef}} which actually defines the function.

</translate><translate>


:{{Tag|funcdef}}


::A function and it's return type.

</translate><translate>


:{{Tag|funcparams}}


::Contains the list of parameters for the function.

</translate><translate>


:{{Tag|paramdef}}


::Information about the parameters of a function.

</translate><translate>


:{{Tag|void}}


::An empty element in a function indicating there are no arguments.

</translate><translate>


:{{Tag|varargs}}


::An empty element in a function indicating there are multiple arguments, without specifically listing them. This is generally represented with an ellipsis (...). For example <tt>int max(...);</tt>

</translate><translate>


:{{Tag|funcsynopsisinfo}}


::Not used in KDE documentation.

</translate><translate>

{{Tag|arg}}


:Used inside [[#cmdsynopsis|{{Tag|cmdsynopsis}}]]. Since most KDE applications are &GUI; only, you won't see this very often. See the entry for [[#cmdsynopsis|{{Tag|cmdsynopsis}}]] for a full explanation and example.

</translate><translate>

{{Tag|group}}


:Group

</translate><translate>

{{Tag|sbr}}


:sbr

</translate><translate>

{{Tag|synopfragment}}


:synopfragment

</translate><translate>

{{Tag|modifier}}


:A modifier modifies a class, field, or method synopsis. Examples are the words "public", "private" or "virtual"

</translate><translate>

{{Tag|fieldsynopsis}}


:A field synopsis.

</translate>



<translate>


{{Prevnext2
| prevpage=Documentation Primer/Manual/DocBook Reference/Tips
| prevtext=Admonitions - Tips, hints, and Warnings
| nextpage=Documentation Primer/Manual/DocBook Reference/Programming
| nexttext=Markup for programming
| index=Documentation Primer/Manual
| indextext=Back to Menu
}}

</translate>

← Older revision		Revision as of 08:31, 2 September 2012
Line 1:		Line 1:
	<languages />		<languages />
−	~~{{Transferring}}~~
	<translate>		<translate>

← Older revision		Revision as of 09:08, 1 September 2012
Line 1:		Line 1:
		+	<languages />
		+	{{Transferring}}
	<translate>		<translate>

@@ Line 145: / Line 145: @@
 <!--T:33-->
-:Used inside [[#cmdsynopsis|{{Tag|cmdsynopsis}}]].  Since most KDE applications are &GUI; only, you won't see this very often.  See the entry for  [[#cmdsynopsis|{{Tag|cmdsynopsis}}]] for a full explanation and example.
+:Used inside [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/Synopsis#cmdsynopsis|{{Tag|cmdsynopsis}}]].  Since most KDE applications are &GUI; only, you won't see this very often.  See the entry for  [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/Synopsis#cmdsynopsis|{{Tag|cmdsynopsis}}]] for a full explanation and example.
 </translate><span id="group"></span><translate>
@@ Line 330: / Line 330: @@
 <!--T:44-->
 {{Prevnext2
-| prevpage=Documentation Primer/Manual/DocBook Reference/Tips
+| prevpage=Special:myLanguage/Documentation Primer/Manual/DocBook Reference/Tips
 | prevtext=Admonitions - Tips, hints, and Warnings
-| nextpage=Documentation Primer/Manual/DocBook Reference/Programming
+| nextpage=Special:myLanguage/Documentation Primer/Manual/DocBook Reference/Programming
 | nexttext=Markup for programming
-| index=Documentation Primer/Manual
+| index=Special:myLanguage/Documentation Primer/Manual
 | indextext=Back to Menu
 }}
 </translate>

Documentation Primer/Manual/DocBook Reference/Synopsis - Revision history

Claus chr: Corrected links

Claus chr at 08:31, 2 September 2012

Claus chr at 09:08, 1 September 2012

Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase

Annew: Marked this version for translation