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

Claus chr: Corrected links

2012-09-09T10:18:06Z

Corrected links

Claus chr at 08:28, 2 September 2012

2012-09-02T08:28:25Z

Claus chr at 09:05, 1 September 2012

2012-09-01T09:05:51Z

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-30T14:33:34Z

Marked this version for translation

New page

<translate>

=== The Prologue === 


{{Input|1=<nowiki><?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [

<!ENTITY <replaceable>kmyapplication</replaceable> "<application>KMyApp</application>">
<!ENTITY kappname "<replaceable>&kmyapplication;</replaceable>">
<!ENTITY package "<replaceable>kde-module</replaceable>">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"> 
]></nowiki>}}


In general, this needs minimal changing from the template. The items you ''must'' change are the entities "kappname", "package", and "English".


The entity "kappname" looks like it's redundant (as the comment in the template notes), but it is important. This allows us to use one global text in all documents, and still refer to the specific application by its correct name. So it should be changed to refer to this new entity, but this time you should only change the part in quotes ("&kmyapplication;") as follow:


:'''Example: Setting up the global "kappname" entity'''


:{{Input|1=<nowiki>From:


<!ENTITY kappname "&kmyapplication;" -- this only *seems* redundant -->


To:


<!ENTITY kappname "&kate;" -- this only *seems* redundant --></nowiki>}}


In short: change any occurrence of "kmyapplication" to the real name of your application. Do ''not'' use "kappname" or "kapp" directly in a document yourself.


The entity "package" is used similarly. It allows us to insert a single piece of "boilerplate" text into every document, and have the correct package name inserted when the document is compiled. Use the cvs module name, in lower case, &eg; "kdeedu" or "kdebase".


The entity %addindex; is a toggle. If set to "INCLUDE" a document index will be automatically generated. It is normally set instead to "IGNORE", and should not be changed unless you really do want to generate an index. You can find out more about indexes in [[Documentation Primer/Manual/DocBook Reference/Reference|References, indexes, and glossaries]].


:'''Example: A KDE User Manual Prolog'''


:Here is an example of a completely set up prolog, as it normally looks. This is the prolog from the AMOR documentation


:{{Input|1=<nowiki><?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&amor;">
<!ENTITY package "kdetoys">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]></nowiki>}}


:'''Note'''


:The entity "English" should be changed to reflect your language, if you are either writing original documentation in another language, or you are translating a document. For KDE the original documentation should always be in English, so you should not need to change this when writing. For informational purposes, the currently supported languages are:


* Afrikaans
* British-English
* Bulgarian
* Catalan
* Czech
* Danish
* German
* Greek
* English
* Spanish
* Estonian
* Finnish
* Faroese
* French
* Hebrew
* Hungarian
* Indonesian
* Italian
* Japanese
* Dutch
* Norwegian (Note, this is only for compatibility, either Norwegian-Bokmal or Norwegian-Nynorsk should be used in preference.)
* Norwegian-Bokmal
* Norwegian-Nynorsk
* Polish
* Portuguese
* Brasilian-Portuguese
* Romanian
* Russian
* Slovak
* Slovenian
* Serbian
* Swedish
* Turkish
* Ukrainian
* Walloon
* Xhosa
* Continental-Chinese
* Traditional-Chinese


{{Prevnext2
| prevpage=Documentation Primer/Manual/DocBook Reference/This Document
| prevtext=Purpose of this document
| nextpage=Documentation Primer/Manual/DocBook Reference/Book and Bookinfo
| nexttext=The book and the bookinfo section
| index=Documentation Primer/Manual
| indextext=Back to Menu
}}

</translate>

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

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

@@ Line 50: / Line 50: @@
 <!--T:12-->
-The entity %addindex; is a toggle.  If set to "INCLUDE" a document index will be automatically generated.  It is normally set instead to "IGNORE", and should not be changed unless you really do want to generate an index.  You can find out more about indexes in [[Documentation Primer/Manual/DocBook Reference/Reference|References, indexes, and glossaries]].
+The entity %addindex; is a toggle.  If set to "INCLUDE" a document index will be automatically generated.  It is normally set instead to "IGNORE", and should not be changed unless you really do want to generate an index.  You can find out more about indexes in [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/Reference|References, indexes, and glossaries]].
 <!--T:13-->
@@ Line 115: / Line 115: @@
 <!--T:19-->
 {{Prevnext2
-| prevpage=Documentation Primer/Manual/DocBook Reference/This Document
+| prevpage=Special:myLanguage/Documentation Primer/Manual/DocBook Reference/This Document
 | prevtext=Purpose of this document
-| nextpage=Documentation Primer/Manual/DocBook Reference/Book and Bookinfo
+| nextpage=Special:myLanguage/Documentation Primer/Manual/DocBook Reference/Book and Bookinfo
 | nexttext=The book and the bookinfo section
-| index=Documentation Primer/Manual
+| index=Special:myLanguage/Documentation Primer/Manual
 | indextext=Back to Menu
 }}
 </translate>