Warning, /sdk/kommit/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!-- Define an entity for your application if it is not part of KDE
0004        Git -->
0005   <!ENTITY kmyapplication "<application>kommit</application>">
0006   <!ENTITY i18n-translatable-entity "<application>Translatable Entity</application>">
0007   <!ENTITY % addindex "IGNORE">
0008   <!ENTITY % English "INCLUDE">
0009 
0010   <!-- Do not define any other entities; instead, use the entities
0011        from entities/general.entities and en/user.entities. -->
0012 ]>
0013 
0014 <!--
0015 Use this template for application docbooks
0016 For kioslave, systemsettings (kcontrol) modules and simple/short application docbooks use article-template.docbook
0017 Rename this template to index.docbook and place into the directory doc/ or doc/appname if you have several applications in one doc directory
0018 -->
0019 
0020 <!-- kdoctemplate v0.13.0 2017-07-31 ltoscano
0021      add CC BY-SA 4.0 International and set as default
0022 
0023      kdoctemplate v0.12.0 2016-04-23 lueck
0024      add translatable entities
0025      remove help.menu.documentation entity
0026      and add some examples how to use the common menus Settings and Help
0027 
0028      kdoctemplate v0.11.0 2015-04-03 lueck
0029      updated instructions for date + releaseinfo
0030      remove ENTITY package - not used anymore
0031      add info about KDE Games special chapters
0032      Appendix Installation is now optional
0033 
0034      kdoctemplate v0.10.0 2014-04-02 ltoscano
0035      updated to KF5/kdoctools
0036      references to KDE reworded
0037 
0038      kdoctemplate v0.9.2 2012-10-15 pino
0039      update versions to 4.9
0040      update years to 2012
0041      switch from CVS to Git
0042      add id attribute to <book>
0043      
0044      kdoctemplate v0.9.1 2010-10-27 lueck
0045      changed releaseinfo format
0046      removed screenshot format="EPS
0047      added comment when to write a command reference
0048      added tip using id's in varlistentries
0049      removed refentry stuff
0050      
0051      kdoctemplate v0.9 January 10 2003
0052      Changes to comments to clarify entity usage January 10 2003
0053      Minor update to "Credits and Licenses" section on August 24, 2000
0054      Removed "Revision history" section on 22 January 2001
0055      Changed to Installation/Help menu entities 18 October 2001
0056      Other minor cleanup and changes 18 October 2001
0057      FPI change and minor changes November 2002 -->
0058 
0059 <!--
0060 This template was designed by: David Rugge davidrugge@mindspring.com
0061 with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
0062 and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
0063 of the KDE DocBook team.
0064 
0065 You may freely use this template for writing any sort of KDE documentation.
0066 If you have any changes or improvements, please let us know.
0067 
0068 Remember:
0069 - in XML, the case of the <tags> and attributes is relevant ;
0070 - also, quote all attributes.
0071 
0072 Please don't forget to remove all these comments in your final documentation,
0073 thanks ;-).
0074 -->
0075 
0076 <!-- ................................................................ -->
0077 
0078 <!-- The language must NOT be changed here. -->
0079 <!-- If you are writing original documentation in a language other -->
0080 <!-- than English, change the language above ONLY, not here -->
0081 <!-- Change the value of id to the name of your application -->
0082 <book id="kmyapplication" lang="&language;">
0083 
0084 <!-- This header contains all of the meta-information for the document such
0085 as Authors, publish date, the abstract, and Keywords -->
0086 
0087 <bookinfo>
0088     <title>The &kmyapplication; Handbook</title>
0089 
0090     <authorgroup>
0091         <author>
0092         <!-- This is just put in as an example.  For real documentation, please
0093              define a general entity in entities/contributor.entities, e.g.
0094         <!ENTITY George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>">
0095         <!ENTITY George.N.Ugnacious.mail "<email>gnu@kde.org</email>">
0096         and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
0097          -->
0098             <personname>
0099                 <firstname>Hamed</firstname>
0100                 <othername></othername>
0101                 <surname>Masafi</surname>
0102             </personname>
0103             <email>hamed.masafi@gmail.com</email>
0104         </author>
0105         <!-- TRANS:ROLES_OF_TRANSLATORS -->
0106     </authorgroup>
0107 
0108     <copyright>
0109         <year>2021</year>
0110         <holder>Hamed Masafi</holder>
0111     </copyright>
0112 
0113     <legalnotice>&CCBYSA4Notice;</legalnotice>
0114 
0115     <!-- Date of the documentation
0116     Change date/releaseinfo only if
0117        docbook is updated and verified to be valid for the current app version
0118        or
0119        docbook is proofread and verified to be valid for the current app version
0120     Don't forget to include this last date.
0121     Please respect the format of the date (YYYY-MM-DD),it is used by scripts.
0122     -->
0123     <date>2021-04-23</date>
0124 
0125     <!--version information of Frameworks/Plasma/Applications this documentation is valid for.
0126     Example:
0127     Frameworks xx.yy for docbooks in frameworks
0128     Plasma xx.yy for docbooks in plasma workspace
0129     Applications xx.yy for docbooks released as Applications
0130     xx.yy (Applications xx.yy) for docbooks with own version released as Applications
0131     $applicationname xx.yy for applications with independent release schedule (extragear/playground)
0132     -->
0133     <releaseinfo>
0134         kommit 0.1
0135     </releaseinfo>
0136 
0137     <!-- Abstract about this handbook -->
0138 
0139     <abstract>
0140         <para>
0141             &kmyapplication; is an application specially designed to aim user to doing git command bu gui.
0142         </para>
0143     </abstract>
0144 
0145     <!-- This is a set of Keywords for indexing by search engines.
0146     Please at least include KDE, the KDE section it is in, the name
0147      of your application, and a few relevant keywords. -->
0148 
0149     <keywordset>
0150         <keyword>KDE</keyword>
0151         <keyword>Git</keyword>
0152         <keyword>Git gui</keyword>
0153     </keywordset>
0154 
0155 </bookinfo>
0156 
0157 <!-- The contents of the documentation begin here.  Label
0158 each chapter so with the id attribute. This is necessary for two reasons: it
0159 allows you to easily reference the chapter from other chapters of your
0160 document, and if there is no ID, the name of the generated HTML files will vary
0161 from time to time making it hard to manage for maintainers and for the CVS
0162 system. Any chapter labelled (OPTIONAL) may be left out at the author's
0163 discretion. Other chapters should not be left out in order to maintain a
0164 consistent documentation style across all KDE apps. -->
0165 
0166 
0167 <!-- KDE Games have special chapters
0168 
0169 Introduction
0170 
0171 How to play
0172 
0173 Game Rules, Strategies and Tips
0174 
0175 Interface Overview
0176 
0177 Frequently asked questions
0178 
0179 Credits and License
0180 
0181 Please use one of index.docbook files from kdegames
0182 
0183 -->
0184 <chapter id="introduction">
0185 <title>Introduction</title>
0186 
0187 <!-- The introduction chapter contains a brief introduction for the
0188 application that explains what it does and where to report
0189 problems. Basically a long version of the abstract.  Don't include a
0190 revision history. (see installation appendix comment) -->
0191 
0192 <para>
0193 &kmyapplication; is a program that lets you do absolutely nothing. Please report
0194 any problems or feature requests to the &kde; mailing lists.
0195 </para>
0196 </chapter>
0197 
0198 <chapter id="using-kapp">
0199 <title>Using &kmyapplication;</title>
0200 
0201 <!-- This chapter should tell the user how to use your app. You should use as
0202 many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
0203 your application. -->
0204 
0205 <para>
0206 
0207 <!-- Note that all graphics should be in .png format. Use no gifs because of
0208 patent issues. -->
0209 
0210 <screenshot>
0211 <screeninfo>Here's a screenshot of &kmyapplication;</screeninfo>
0212         <mediaobject>
0213           <imageobject>
0214             <imagedata fileref="screenshot_main.png" format="PNG"/>
0215           </imageobject>
0216           <textobject>
0217             <phrase>Screenshot</phrase>
0218           </textobject>
0219         </mediaobject>
0220 </screenshot>
0221 </para>
0222 
0223 
0224 <sect1 id="kapp-features">
0225 <title>More &kmyapplication; features</title>
0226 
0227 <para>It slices! It dices! and it comes with a free toaster!</para>
0228 <para>
0229 The Squiggle Tool <guiicon><inlinemediaobject>
0230           <imageobject>
0231             <imagedata fileref="squiggle.png" format="PNG"/>
0232           </imageobject>
0233           <textobject>
0234             <phrase>Squiggle</phrase>
0235           </textobject>
0236 </inlinemediaobject></guiicon> is used to draw squiggly lines all over
0237 the &kmyapplication; main window. It's not a bug, it's a feature!
0238 </para>
0239 
0240 </sect1>
0241 </chapter>
0242 
0243 <chapter id="commands">
0244 <title>Command Reference</title>
0245 
0246 <!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
0247 application windows and their menubar and toolbar commands for easy reference.
0248 Also include any keys that have a special function but have no equivalent in the
0249 menus or toolbars. 
0250 This may not be necessary for small apps or apps with no tool or menu bars.
0251 
0252 Don't bother users with well known kde menu items like Settings->Shortcuts etc. 
0253 
0254 Use cases for a command reference:
0255 
0256 Applications with many menu items (Kate/Konqueror) 
0257 Applications with different modes and menus (KWrite/Konqueror)
0258 -> Enables search for menu items
0259 
0260 For Applications with default menu items and some special items where user 
0261 needs additional information use something like:
0262 "Apart from the common KDE menu items you find these action in the menu:
0263 
0264 File -> Special Action: Explanation of special action
0265 
0266 Tools -> Special Tool: Explanation of special tool
0267 
0268 Use variablelist markup for this
0269 -->
0270 
0271 <sect1 id="kapp-mainwindow">
0272 <title>The main &kmyapplication; window</title>
0273 
0274 <sect2>
0275 <title>The File Menu</title>
0276 <para>
0277 <variablelist>
0278 <varlistentry  id="file-new">
0279 <!-- Tip: With id's here, then you can use them like 
0280 "select <xref linkend="file-new"/> to open the file dialog"
0281 which will be expanded to:
0282 "select File->New (Ctrl+N) to open the file dialog"
0283 -->
0284 <term><menuchoice>
0285 <shortcut>
0286 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
0287 </shortcut>
0288 <guimenu>File</guimenu>
0289 <guimenuitem>New</guimenuitem>
0290 </menuchoice></term>
0291 <listitem><para><action>Creates a new document</action></para></listitem>
0292 </varlistentry>
0293 
0294 <varlistentry  id="file-save">
0295 <term><menuchoice>
0296 <shortcut>
0297 <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
0298 </shortcut>
0299 <guimenu>File</guimenu>
0300 <guimenuitem>Save</guimenuitem>
0301 </menuchoice></term>
0302 <listitem><para><action>Saves the document</action></para></listitem>
0303 </varlistentry>
0304 
0305 <varlistentry  id="file-quit">
0306 <term><menuchoice>
0307 <shortcut>
0308 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
0309 </shortcut>
0310 <guimenu>File</guimenu>
0311 <guimenuitem>Quit</guimenuitem>
0312 </menuchoice></term>
0313 <listitem><para><action>Quits</action> &kmyapplication;</para></listitem>
0314 </varlistentry>
0315 </variablelist>
0316 </para>
0317 
0318 </sect2>
0319 
0320 <!-- Examples how to use the common menus Settings and Help -->
0321 
0322 <sect2 id="settings-help-menu">
0323 <title>The Settings and Help Menu</title>
0324 <para>
0325 &kmyapplication; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0326 menu items, for more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings"
0327 >Settings Menu</ulink> and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>
0328 of the &kde; Fundamentals.
0329 </para>
0330 </sect2>
0331 
0332 <sect2 id="help-menu1">
0333 <title>The Help Menu</title>
0334 <para>
0335 &kmyapplication; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section
0336 about the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
0337 </para>
0338 </sect2>
0339 
0340 <sect2 id="menu-commands">
0341 <title>Menu Items</title>
0342 <para>Apart from the common &kde; menus described in the <ulink url="help:/fundamentals/ui.html#menus">Menu</ulink>
0343 chapter of the &kde; Fundamentals documentation &kmyapplication; has these application specific menu entries:
0344 </para>
0345 <!-- variablelist -->
0346 </sect2>
0347 
0348 <sect2 id="help-menu2">
0349 <title>The Help Menu</title>
0350 <para>&kmyapplication; has a default &kde; <guimenu>Help</guimenu> menu as described in the
0351 <ulink url="help:/fundamentals/ui.html#menus-help">&kde; Fundamentals</ulink>
0352 with two additional entries:</para>
0353 <!-- variablelist -->
0354 </sect2>
0355 
0356 </sect1>
0357 </chapter>
0358 
0359 <chapter id="developers">
0360 <title>Developer's Guide to &kmyapplication;</title>
0361 
0362 <!-- (OPTIONAL) A Programming/Scripting reference chapter should be
0363 used for apps that use plugins or that provide their own scripting hooks
0364 and/or development libraries. -->
0365 
0366 <para>
0367 Programming &kmyapplication; plugins is a joy to behold.
0368 </para>
0369 
0370 
0371 </chapter>
0372 
0373 <chapter id="faq">
0374 <title>Questions and Answers</title>
0375 
0376 <!-- (OPTIONAL but recommended) This chapter should include all of the silly
0377 (and not-so-silly) newbie questions that fill up your mailbox. This chapter
0378 should be reserved for BRIEF questions and answers! If one question uses more
0379 than a page or so then it should probably be part of the
0380 "Using this Application" chapter instead. You should use links to
0381 cross-reference questions to the parts of your documentation that answer them.
0382 This is also a great place to provide pointers to other FAQ's if your users
0383 must do some complicated configuration on other programs in order for your
0384 application work. -->
0385 
0386 <qandaset id="faqlist">
0387 <qandaentry>
0388 <question>
0389 <para>My Mouse doesn't work. How do I quit &kmyapplication;?</para>
0390 </question>
0391 <answer>
0392 <para>You silly goose! Check out the <link linkend="commands">Commands
0393 Section</link> for the answer.</para>
0394 </answer>
0395 </qandaentry>
0396 <qandaentry>
0397 <question>
0398 <para>Why can I not twiddle my documents?</para>
0399 </question>
0400 <answer>
0401 <para>You can only twiddle your documents if you have the foobar.lib
0402 installed.</para>
0403 </answer>
0404 </qandaentry>
0405 </qandaset>
0406 </chapter>
0407 
0408 <chapter id="credits">
0409 
0410 <!-- Include credits for the programmers, documentation writers, and
0411 contributors here. The license for your software should then be included below
0412 the credits with a reference to the appropriate license file included in the KDE
0413 distribution. -->
0414 
0415 <title>Credits and License</title>
0416 
0417 <para>
0418 &kmyapplication;
0419 </para>
0420 <para>
0421 Program copyright 2010-2014 John Q. Hacker <email>jqh@kde.org</email>
0422 </para>
0423 <para>
0424 Contributors:
0425 <itemizedlist>
0426 <listitem><para>Konqui the &kde; Dragon <email>konqui@kde.org</email></para>
0427 </listitem>
0428 <listitem><para>Tux the &Linux; Penguin <email>tux@linux.org</email></para>
0429 </listitem>
0430 </itemizedlist>
0431 </para>
0432 
0433 <para>
0434 Documentation Copyright &copy; 2012-2014 George N. Ugnacious <email>gnu@kde.org</email>
0435 </para>
0436 
0437 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0438 
0439 <!-- License for new documents after 2017-07-27 (or relicensed) -->
0440 
0441 &underCCBYSA4;           <!-- CC BY-SA 4.0: do not remove -->
0442 
0443 <!-- FDL: old license; only for reference (and old documents) -->
0444 <!--
0445 &underFDL;
0446 -->
0447 
0448 <!-- Determine which license your application is licensed under,
0449      and delete all the remaining licenses below:
0450 
0451      (NOTE:  All documentation are licensed under the CC BY-SA 4.0,
0452      regardless of what license the application uses) -->
0453 
0454 &underGPL;               <!-- GPL License -->
0455 &underBSDLicense;        <!-- BSD License -->
0456 &underArtisticLicense;   <!-- BSD Artistic License -->
0457 &underX11License;        <!-- X11 License  -->
0458 
0459 </chapter>
0460 
0461 <!-- Appendix Installation is optional, usually not required
0462 
0463 Entities &install.intro.documentation; + &install.compile.documentation; will be removed in later kdoctools
0464 
0465 -->
0466 
0467 <appendix id="installation">
0468 <title>Installation</title>
0469 
0470 <sect1 id="getting-kapp">
0471 <title>How to obtain &kmyapplication;</title>
0472 
0473 <!-- This first entity contains boiler plate for applications that are
0474 part of KDE archive.  You should remove it if you are releasing your
0475 application -->
0476 
0477 &install.intro.documentation;
0478 
0479 </sect1>
0480 
0481 <sect1 id="requirements">
0482 <title>Requirements</title>
0483 
0484 <!--
0485 List any special requirements for your application here. This should include:
0486 .Libraries or other software that is not included in kdesupport or kf5
0487 .Hardware requirements like amount of RAM, disk space, graphics card
0488 capabilities, screen resolution, special expansion cards, etc.
0489 .Operating systems the app will run on. If your app is designed only for a
0490 specific OS, (you wrote a graphical LILO configurator for example) put this
0491 information here.
0492 -->
0493 
0494 <para>
0495 In order to successfully use &kmyapplication;, you need few libraries from
0496 &kde-frameworks; 5.1 (bar, baz). Foobar.lib is
0497 required in order to support the advanced &kmyapplication; features. &kmyapplication; uses
0498 about 5 megs of memory to run, but this may vary depending on your
0499 platform and configuration.
0500 </para>
0501 
0502 <para>
0503 All required libraries as well as &kmyapplication; itself can be found
0504 on <ulink url="ftp://ftp.kapp.org">The &kmyapplication; home page</ulink>.
0505 </para>
0506 
0507 <!-- For a list of updates, you may refer to the application web site
0508 or the ChangeLog file, or ... -->
0509 <para>
0510 You can find a list of changes at <ulink
0511 url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>.
0512 </para>
0513 </sect1>
0514 
0515 <sect1 id="compilation">
0516 <title>Compilation and Installation</title>
0517 
0518 <!-- This entity contains the boilerplate text for standard -->
0519 <!-- compilation instructions.  If your application requires any -->
0520 <!-- special handling, remove it, and replace with your own text. -->
0521 
0522 &install.compile.documentation;
0523 
0524 </sect1>
0525 
0526 <sect1 id="configuration">
0527 <title>Configuration</title>
0528 
0529 <para>Don't forget to tell your system to start the <filename>dtd</filename>
0530 dicer-toaster daemon first, or &kmyapplication; won't work!</para>
0531 
0532 </sect1>
0533 
0534 </appendix>
0535 
0536 &documentation.index;
0537 </book>
0538 
0539 <!--
0540 Local Variables:
0541 mode: xml
0542 sgml-minimize-attributes:nil
0543 sgml-general-insert-case:lower
0544 sgml-indent-step:0
0545 sgml-indent-data:nil
0546 End:
0547 
0548 vim:tabstop=2:shiftwidth=2:expandtab
0549 kate: space-indent on; indent-width 4; tab-width 4; indent-mode none;
0550 -->