diff options
Diffstat (limited to 'kdoctools/customization/en')
18 files changed, 376 insertions, 0 deletions
diff --git a/kdoctools/customization/en/catalog b/kdoctools/customization/en/catalog new file mode 100644 index 000000000..e578e704e --- /dev/null +++ b/kdoctools/customization/en/catalog @@ -0,0 +1,38 @@ +PUBLIC "-//KDE//ENTITIES English Documentation V1.0//EN" + "lang.entities" + +PUBLIC "-//KDE//DOCUMENT GNU Free Documentation Notice//EN" + "entities/fdl-notice.docbook" +PUBLIC "-//KDE//DOCUMENT GNU General Public License Notice//EN" + "entities/gpl-notice.docbook" +PUBLIC "-//KDE//DOCUMENT GNU Lesser General Public License Notice//EN" + "entities/lgpl-notice.docbook" + +PUBLIC "-//GNU//DOCUMENT GNU General Public License V2//EN" + "common/gpl-translated" +PUBLIC "-//GNU//DOCUMENT GNU Lesser General Public License V2.1//EN" + "common/lgpl-translated" +PUBLIC "-//GNU//DOCUMENT GNU Free Documentation License V1.1//EN" + "common/fdl-translated" +PUBLIC "-//KDE//DOCUMENT GPL Licence Declaration//EN" + "entities/underGPL.docbook" +PUBLIC "-//KDE//DOCUMENT LGPL Licence Declaration//EN" + "entities/underLGPL.docbook" +PUBLIC "-//KDE//DOCUMENT FDL Licence Declaration//EN" + "entities/underFDL.docbook" +PUBLIC "-//KDE//DOCUMENT BSD Licence Declaration//EN" + "entities/underBSDLicense.docbook" +PUBLIC "-//KDE//DOCUMENT Artistic Licence Declaration//EN" + "entities/underArtisticLicense.docbook" +PUBLIC "-//KDE//DOCUMENT X11 Licence Declaration//EN" + "entities/underX11License.docbook" +PUBLIC "-//KDE//DOCUMENT Report Bugs//EN" + "entities/report-bugs.docbook" +PUBLIC "-//KDE//DOCUMENT Updating Documentation//EN" + "entities/update-doc.docbook" +PUBLIC "-//KDE//DOCUMENT Help Menu Documentation//EN" + "entities/help-menu.docbook" +PUBLIC "-//KDE//DOCUMENT Installation General Information//EN" + "entities/install-intro.docbook" +PUBLIC "-//KDE//DOCUMENT Compilation Instructions//EN" + "entities/install-compile.docbook" diff --git a/kdoctools/customization/en/entities/fdl-notice.docbook b/kdoctools/customization/en/entities/fdl-notice.docbook new file mode 100644 index 000000000..7c4402cda --- /dev/null +++ b/kdoctools/customization/en/entities/fdl-notice.docbook @@ -0,0 +1,53 @@ +<!-- This file can be used to include the notice in documentation + <!DOCTYPE book ... [ + <!ENTITY % FDLIS "INCLUDE"> + <!ENTITY FDLISTitles "title 1, title 2, title 3"> + <!ENTITY % FDLFCT "INCLUDE"> + <!ENTITY FDLFCTTitles "title 4, title 5, title 6"> + <!ENTITY % FDLBCT "INCLUDE"> + <!ENTITY FDLBCTTitles "title 7, title 7b"> + <!ENTITY % ents "-//KDE//ENTITIES Application-Variable Entities V1.0//EN"> + %ents; + ... + ]> + ... + <bookinfo> + <legalnotice> + <para>Copyright (C) 20yy [name of author]</para> + &FDLnotice; + </legalnotice> + </bookinfo> + ... + + Alternatively, you can include the text literally. + + Include a copy of the license in the documentation distribution. + --> +<para>Permission is granted to copy, distribute and/or modify this +document under the terms of the GNU Free Documentation License, +Version 1.1 or any later version published by the Free Software +Foundation; with &FDLInvariantSections;, with &FDLFrontCoverText;, and +with &FDLBackCoverText;. A copy of the license is included in <xref linkend="gnu-fdl"/>.</para> + +<!-- If you have no Invariant Sections, don't add any FDLIS entities. + If you have no Front-Cover Texts, don't add any FDLFCT; likewise + for Back-Cover Texts (the SGML setup takes care of complying with + the GNU requirements). Adding the entities: if you use any, then + add FDL* with value "INCLUDE" and FDL*Titles with a list of + titles. You will get the default GNU template text if you don't + specify the FDL*Titles entity after specifying the FDL* entity. + This will only have effect when you specify %FDLSlots; _after_ + the entity definitions. + + If your document contains nontrivial examples of program code, we + recommend releasing these examples in parallel under your choice + of free software license, such as the GNU General Public License, + to permit their use in free software. + --> +<!-- +Local variables: +mode: sgml +sgml-general-insert-case: lower +sgml-parent-document: ("index.docbook" "book" "bookinfo" "legalnotice" "para") +End: +--> diff --git a/kdoctools/customization/en/entities/gpl-notice.docbook b/kdoctools/customization/en/entities/gpl-notice.docbook new file mode 100644 index 000000000..0b093444d --- /dev/null +++ b/kdoctools/customization/en/entities/gpl-notice.docbook @@ -0,0 +1,32 @@ +<!-- This file can be used to include the notice in documentation + <!DOCTYPE book ... > + ... + <bookinfo> + <legalnotice> + <para>Copyright (C) 20yy [name of author]</para> + &GPLnotice; + </legalnotice> + </bookinfo> + ... + + Alternatively, you can include the text literally. + --> +<para>This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License as +published by the Free Software Foundation; either version 2 of the +License, or (at your option) any later version.</para> + +<para>This program is distributed in the hope that it will be +useful, but WITHOUT ANY WARRANTY; without even the implied warranty +of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details.</para> + +<para>You should have received a copy of the GNU General Public +License along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</para> +<!-- +Local variables: +mode: sgml +sgml-general-insert-case: lower +End: +--> diff --git a/kdoctools/customization/en/entities/help-menu.docbook b/kdoctools/customization/en/entities/help-menu.docbook new file mode 100644 index 000000000..309abcde6 --- /dev/null +++ b/kdoctools/customization/en/entities/help-menu.docbook @@ -0,0 +1,58 @@ +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F1</keycap></keycombo> +</shortcut> +<guimenu>Help</guimenu> +<guimenuitem>&kappname; Handbook</guimenuitem> +</menuchoice> +</term> +<listitem><para><action>Invokes the KDE Help system</action> starting at the +&kappname; help pages. (this document).</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo> +</shortcut> +<guimenu>Help</guimenu> +<guimenuitem>What's This?</guimenuitem> +</menuchoice> +</term> +<listitem><para><action>Changes the mouse cursor to a combination arrow and +question mark.</action> Clicking on items within &kappname; will open a help +window (if one exists for the particular item) explaining the item's +function.</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>Report Bug...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens the Bug report dialog</action> where you can +report a bug or request a <quote>wishlist</quote> feature.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>About &kappname;</guimenuitem> +</menuchoice></term> +<listitem><para><action>This will display version and author +information.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>About KDE</guimenuitem> +</menuchoice></term> +<listitem><para><action>This displays the KDE version and other basic +information.</action></para></listitem> +</varlistentry> +</variablelist> diff --git a/kdoctools/customization/en/entities/install-compile.docbook b/kdoctools/customization/en/entities/install-compile.docbook new file mode 100644 index 000000000..dccdc4081 --- /dev/null +++ b/kdoctools/customization/en/entities/install-compile.docbook @@ -0,0 +1,12 @@ +<para>In order to compile and install &kappname; on your system, type the +following in the base directory of the &kappname; distribution:</para> + +<screen><prompt>%</prompt> <userinput><command>./configure</command></userinput> +<prompt>%</prompt> <userinput><command>make</command></userinput> +<prompt>%</prompt> <userinput><command>make</command> install</userinput> +</screen> + +<para>Since &kappname; uses <command>autoconf</command> and +<command>automake</command> you should have no trouble compiling it. Should you +run into problems please report them to the &kde; mailing lists.</para> + diff --git a/kdoctools/customization/en/entities/install-intro.docbook b/kdoctools/customization/en/entities/install-intro.docbook new file mode 100644 index 000000000..3f6f5edb5 --- /dev/null +++ b/kdoctools/customization/en/entities/install-intro.docbook @@ -0,0 +1,6 @@ +<!-- requires that packagename is defined in the documentation prologue + --> +<para>&kappname; is part of the &kde; project &kde-http;.</para> + +<para>&kappname; can be found in the &package; package on &kde-ftp;, +the main &FTP; site of the &kde; project.</para> diff --git a/kdoctools/customization/en/entities/lgpl-notice.docbook b/kdoctools/customization/en/entities/lgpl-notice.docbook new file mode 100644 index 000000000..1edf3f609 --- /dev/null +++ b/kdoctools/customization/en/entities/lgpl-notice.docbook @@ -0,0 +1,33 @@ +<!-- This file can be used to include the notice in documentation + <!DOCTYPE book ... > + ... + <bookinfo> + <legalnotice> + <para>Copyright (C) 20yy [name of author]</para> + &LGPLnotice; + </legalnotice> + </bookinfo> + ... + + Alternatively, you can include the text literally. + --> +<para>This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public License +as published by the Free Software Foundation; either version 2 of +the License, or (at your option) any later version.</para> + +<para>This library is distributed in the hope that it will be +useful, but WITHOUT ANY WARRANTY; without even the implied warranty +of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details.</para> + +<para>You should have received a copy of the GNU Lesser General +Public License along with this library; if not, write to the Free +Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +02110-1301 USA</para> +<!-- +Local variables: +mode: sgml +sgml-general-insert-case: lower +End: +--> diff --git a/kdoctools/customization/en/entities/report-bugs.docbook b/kdoctools/customization/en/entities/report-bugs.docbook new file mode 100644 index 000000000..c9f2992f2 --- /dev/null +++ b/kdoctools/customization/en/entities/report-bugs.docbook @@ -0,0 +1 @@ +<!-- --> diff --git a/kdoctools/customization/en/entities/underArtisticLicense.docbook b/kdoctools/customization/en/entities/underArtisticLicense.docbook new file mode 100644 index 000000000..fa022707d --- /dev/null +++ b/kdoctools/customization/en/entities/underArtisticLicense.docbook @@ -0,0 +1,2 @@ +<para>This program is licensed under the terms of the <ulink +url="common/artistic-license.html">Artistic License</ulink>.</para> diff --git a/kdoctools/customization/en/entities/underBSDLicense.docbook b/kdoctools/customization/en/entities/underBSDLicense.docbook new file mode 100644 index 000000000..0dc93f1c4 --- /dev/null +++ b/kdoctools/customization/en/entities/underBSDLicense.docbook @@ -0,0 +1,2 @@ +<para>This program is licensed under the terms of the <ulink +url="common/bsd-license.html">BSD License</ulink>.</para> diff --git a/kdoctools/customization/en/entities/underFDL.docbook b/kdoctools/customization/en/entities/underFDL.docbook new file mode 100644 index 000000000..633ce72e6 --- /dev/null +++ b/kdoctools/customization/en/entities/underFDL.docbook @@ -0,0 +1,4 @@ +<para id="gnu-fdl" xreflabel="the section entitled "GNU Free Documentation +License"">This documentation is licensed under the terms of the <ulink +url="common/fdl-license.html">GNU Free Documentation +License</ulink>.</para> diff --git a/kdoctools/customization/en/entities/underGPL.docbook b/kdoctools/customization/en/entities/underGPL.docbook new file mode 100644 index 000000000..a2074f33d --- /dev/null +++ b/kdoctools/customization/en/entities/underGPL.docbook @@ -0,0 +1,2 @@ +<para>This program is licensed under the terms of the <ulink +url="common/gpl-license.html">GNU General Public License</ulink>.</para> diff --git a/kdoctools/customization/en/entities/underLGPL.docbook b/kdoctools/customization/en/entities/underLGPL.docbook new file mode 100644 index 000000000..35f89bdd6 --- /dev/null +++ b/kdoctools/customization/en/entities/underLGPL.docbook @@ -0,0 +1,2 @@ +<para>This program is licensed under the terms of the <ulink +url="common/lgpl-license.html">GNU Lesser General Public License</ulink>.</para> diff --git a/kdoctools/customization/en/entities/underX11License.docbook b/kdoctools/customization/en/entities/underX11License.docbook new file mode 100644 index 000000000..7eb81f09e --- /dev/null +++ b/kdoctools/customization/en/entities/underX11License.docbook @@ -0,0 +1,2 @@ +<para>This program is licensed under the terms of the <ulink +url="common/x11-license.html">X11 License</ulink>.</para> diff --git a/kdoctools/customization/en/entities/update-doc.docbook b/kdoctools/customization/en/entities/update-doc.docbook new file mode 100644 index 000000000..98149e456 --- /dev/null +++ b/kdoctools/customization/en/entities/update-doc.docbook @@ -0,0 +1,3 @@ +<para>This document may have been updated since your installation. +You can find the latest version at <ulink +url="http://docs.kde.org/development/en/&package;/">http://docs.kde.org/development/en/&package;/</ulink>.</para> diff --git a/kdoctools/customization/en/lang.entities b/kdoctools/customization/en/lang.entities new file mode 100644 index 000000000..8c7be5e18 --- /dev/null +++ b/kdoctools/customization/en/lang.entities @@ -0,0 +1,50 @@ +<!-- Do NOT change this file: it provides important defaults --> + +<!ENTITY language "en"> + +<!-- These entities should be translated, should therefore be stored + separately. --> +<!ENTITY % kde.translated + SYSTEM "strings.entities" > +%kde.translated; + +<!-- The following entities should only use &kappname; in their + text --> + +<!-- Licence links --> +<!ENTITY underGPL PUBLIC "-//KDE//DOCUMENT GPL Licence Declaration//EN" + "entities/underGPL.docbook" ><!-- level: para --> +<!ENTITY underLGPL PUBLIC "-//KDE//DOCUMENT LGPL Licence Declaration//EN" + "entities/underLGPL.docbook" ><!-- level: para --> +<!ENTITY underFDL PUBLIC "-//KDE//DOCUMENT FDL Licence Declaration//EN" + "entities/underFDL.docbook" ><!-- level: para --> +<!ENTITY underBSDLicense PUBLIC "-//KDE//DOCUMENT BSD Licence Declaration//EN" + "entities/underBSDLicense.docbook" ><!-- level: para --> +<!ENTITY underArtisticLicense PUBLIC "-//KDE//DOCUMENT Artistic Licence Declaration//EN" + "entities/underArtisticLicense.docbook" ><!-- level: para --> +<!ENTITY underX11License PUBLIC "-//KDE//DOCUMENT X11 Licence Declaration//EN" + "entities/underX11License.docbook" ><!-- level: para --> + +<!ENTITY reporting.bugs PUBLIC "-//KDE//DOCUMENT Report Bugs//EN" + "entities/report-bugs.docbook" ><!-- level: ? --> +<!ENTITY updating.documentation PUBLIC "-//KDE//DOCUMENT Updating Documentation//EN" + "entities/update-doc.docbook" ><!-- level: para --> +<!ENTITY help.menu.documentation PUBLIC "-//KDE//DOCUMENT Help Menu Documentation//EN" + "entities/help-menu.docbook" ><!-- level: variablelist --> +<!ENTITY install.intro.documentation PUBLIC "-//KDE//DOCUMENT Installation General Information//EN" + "entities/install-intro.docbook" ><!-- level: para --> +<!ENTITY install.compile.documentation PUBLIC "-//KDE//DOCUMENT Compilation Instructions//EN" + "entities/install-compile.docbook" ><!-- level: para --> + + +<!-- FDL notice --> +<!ENTITY FDLNotice PUBLIC "-//KDE//DOCUMENT GNU Free Documentation Notice//EN" + "entities/fdl-notice.docbook"> +<!-- meant to be included, so no NDATA or CDATA (why?) --> + +<!-- These entities may be extended by the authors and translators. + They should therefore be stored separately. Moreover, they MUST + come last, to avoid overriding problems. --> +<!ENTITY % kde.language.specific + SYSTEM "user.entities" > +%kde.language.specific; diff --git a/kdoctools/customization/en/strings.entities b/kdoctools/customization/en/strings.entities new file mode 100644 index 000000000..8288de1c6 --- /dev/null +++ b/kdoctools/customization/en/strings.entities @@ -0,0 +1,39 @@ +<!-- These entities should be translated, but NOT CHANGED, NOR EXTENDED. + For language-specific extensions, use user.entities. + Translate everything between quotes, except names of general + entities (&...;). --> + +<!ENTITY kappname "this application"> +<!-- Entities to fill in slots in docbook version of FDL notice. + The default values of the parameter entities is IGNORE. --> +<![%FDLIS;[ +<!ENTITY FDLISTitles "LIST THEIR TITLES"><!-- keep capitals --> +<!ENTITY FDLInvariantSections "the Invariant Sections being &FDLISTitles;"> + ]]> +<!ENTITY FDLInvariantSections "no Invariant Sections"> +<![%FDLFCT;[ +<!ENTITY FDLFCTTitles "LIST"><!-- keep capitals --> +<!ENTITY FDLFrontCoverText "the Front-Cover Texts being &FDLFCTTitles;"> + ]]> +<!ENTITY FDLFrontCoverText "no Front-Cover Texts"> +<![%FDLBCT;[ +<!ENTITY FDLBCTTitles "LIST THEIR TITLES"><!-- keep capitals --> +<!ENTITY FDLBackCoverText "the Back-Cover Texts being &FDLBCTTitles;"> + ]]> +<!ENTITY FDLBackCoverText "no Back-Cover Texts"> + +<!-- modespec entity: must be adapted in accordance with the normal usage + for documents in a language; the most likely candidates are the value + of xreflabel (now %t for title of section referred to) and the content + (now empty). If more than one format is needed, contact kde-docbook@kde.org. + ** In general, this setup will not work with more than one language in + a document ** + Usage: in <bookinfo> + Only strictly needed when olinks are used + --> +<!--ENTITY kde-modespec '<modespec id="kdems-default" xreflabel="%t"></modespec>'--> +<!ENTITY kde.modespec ' + <modespec id="kdems-help">help:</modespec> + <modespec id="kdems-man">man:</modespec>'> + +<!ENTITY olinktype "kde-installation"> diff --git a/kdoctools/customization/en/user.entities b/kdoctools/customization/en/user.entities new file mode 100644 index 000000000..83cee2a3d --- /dev/null +++ b/kdoctools/customization/en/user.entities @@ -0,0 +1,37 @@ +<!-- This file contains entities (only!) to make authoring/translating + a document easier. They are necessarily language-specific. + In the case of name clashes, entities in this file always lose. + Keep the entities simple, but _always_ provide them with full markup. + Please keep the entities sorted on the name: it will avoid duplicate + names (which if they occur will cost you a _lot_ of time) + --> + +<!ENTITY Alt "<keycap>Alt</keycap>"> +<!ENTITY Backspace "<keycap>Backspace</keycap>"> +<!ENTITY cdrom '<hardware>CD-ROM drive</hardware>'> +<!ENTITY Ctrl "<keycap>Ctrl</keycap>"> +<!ENTITY dpi '<acronym>dpi</acronym>'> +<!ENTITY eg "<abbrev>e.g.</abbrev>"> +<!ENTITY Enter "<keycap>Enter</keycap>"> +<!ENTITY Esc "<keycap>Esc</keycap>"> +<!ENTITY etc "<abbrev>etc.</abbrev>"> +<!ENTITY FAQ '<acronym>FAQ</acronym>'> +<!ENTITY ie "<abbrev>i.e.</abbrev>"> +<!ENTITY infocenter "<application>Info Center</application>"> +<!ENTITY kcontrolcenter "<application>&kde; Control Center</application>"> +<!ENTITY kicon "<guiicon> +<inlinemediaobject> + <objectinfo><title>&kde;'s K-icon</title></objectinfo> + <imageobject><imagedata fileref='common/kmenu.png' format='PNG'/></imageobject> + <textobject><phrase>K</phrase></textobject> +</inlinemediaobject> +</guiicon> icon"><!-- if image is localised, then entityref should be used + instead of fileref --> +<!ENTITY kmenu "<guimenu>K</guimenu> menu"> +<!ENTITY LMB "<mousebutton>left</mousebutton> mouse button"> +<!ENTITY MMB "<mousebutton>middle</mousebutton> mouse button"> +<!ENTITY OS "operating system"><!-- <acronym>OS</acronym>--> +<!ENTITY RMB "<mousebutton>right</mousebutton> mouse button"> +<!ENTITY Shift "<keycap>Shift</keycap>"> +<!ENTITY systemtray "<application>system tray</application>"> +<!ENTITY Tab "<keycap>Tab</keycap>"> |