doc/xml-docbook/index.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
0003 "dtd/kdedbx45.dtd" [
0004   <!ENTITY gdb "<acronym>GDB</acronym>">
0005   <!ENTITY codevis "<acronym>codevis</acronym>">
0006   <!ENTITY kparts "<acronym>KParts</acronym>">
0007
0008   <!ENTITY Tomaz.Canabrava '<personname><firstname>Tomaz</firstname><surname>Canabrava</surname></personname>'>
0009   <!ENTITY Tomaz.Canabrava.mail '<email>tcanabrava@kde.org</email>'>
0010   <!ENTITY Tarcisio.Fischer '<personname><firstname>Tarcisio</firstname><surname>Fischer</surname></personname>'>
0011   <!ENTITY Tarcisio.Fischer.mail '<email>tarcisio.fischer@codethink.co.uk</email>'>
0012   <!ENTITY underApache "Apache 2.0 License">
0013
0014   <!-- If we want more chapters, we copy the configuring one, and adapt. -->
0015   <!ENTITY configuring-chapter SYSTEM "configuring.docbook">
0016   <!ENTITY % addindex "IGNORE">
0017   <!ENTITY % English "INCLUDE"><!-- change language only here -->
0018 ]>
0019
0020 <book id="codevis" lang="&language;">
0021 <title>The &codevis; Handbook</title>
0022
0023 <bookinfo>
0024   <authorgroup>
0025     <author>&Tomaz.Canabrava; &Tomaz.Canabrava.mail;</author>
0026     <!-- TRANS:ROLES_OF_TRANSLATORS -->
0027   </authorgroup>
0028   <copyright>
0029     <year>2023</year>
0030     <holder>&Tomaz.Canabrava;</holder>
0031   </copyright>
0032   <date>2023-10-22</date>
0033   <releaseinfo>Applications 24.00</releaseinfo>
0034   <abstract>
0035     <para>&codevis; is a Large Scale Software visualizer by &kde;.</para>
0036     <para>This handbook documents &codevis; Version 24.00</para>
0037   </abstract>
0038   <keywordset>
0039     <keyword>KDE</keyword>
0040     <keyword>kdebase</keyword>
0041     <keyword>Codevis</keyword>
0042     <keyword>text</keyword>
0043     <keyword>editor</keyword>
0044     <keyword>programmer</keyword>
0045     <keyword>programming</keyword>
0046     <keyword>projects</keyword>
0047     <keyword>MDI</keyword>
0048     <keyword>Multi</keyword>
0049     <keyword>Document</keyword>
0050     <keyword>Interface</keyword>
0051     <keyword>terminal</keyword>
0052     <keyword>console</keyword>
0053   </keywordset>
0054 </bookinfo>
0055
0056 <chapter id="introduction">
0057   <title>Introduction</title>
0058
0059   <para>
0060   Welcome to &codevis;, a programmer's best friend &kde;.
0061   Some of &codevis;'s many features includes software architecture visualization,
0062   manipulation, code generation from diagrams, diagrams generation from source code,
0063   plugins, static analysis, visual static analysis and much more.
0064   </para>
0065
0066   <para>
0067   But &codevis; is more than an architecture helper. Its ability to open
0068   several files at once makes it ideal for visualizing different architectures at once,
0069   and experimenting. Many architectural issues were found and fixed on &codevis; itself by
0070   analyzing it's source code.
0071   </para>
0072
0073   <para>
0074     <mediaobject>
0075       <imageobject>
0076         <imagedata format="PNG" fileref="images/codevis.png"/>
0077       </imageobject>
0078       <caption>
0079         <para>Editing this manual...</para>
0080       </caption>
0081     </mediaobject>
0082   </para>
0083
0084 </chapter>
0085
0086 &configuring-chapter;
0087
0088 <chapter id="credits">
0089   <title>Credits and License</title>
0090   <para>
0091   &codevis;. Program copyright 2023 by the &codevis; developer team.
0092   </para>
0093
0094   <variablelist>
0095     <title>The &codevis; team:</title>
0096     <varlistentry>
0097       <term>&Tomaz.Canabrava; &Tomaz.Canabrava.mail;</term>
0098       <listitem>
0099         <para>Developer</para>
0100       </listitem>
0101     </varlistentry>
0102     <varlistentry>
0103       <term>&Tarcisio.Fischer; &Tarcisio.Fischer.mail;</term>
0104       <listitem>
0105         <para>Developer</para>
0106       </listitem>
0107     </varlistentry>
0108   </variablelist>
0109   <para>Documentation copyright 2023 &Tomaz.Canabrava;
0110   &Tomaz.Canabrava.mail;</para>
0111 </chapter>
0112 </book>
0113
0114 <!--
0115 Local Variables:
0116 mode: sgml
0117 sgml-namecase-general: t
0118 sgml-namecase-entity: nil
0119 sgml-general-insert-case: lower
0120 sgml-minimize-attributes: nil
0121 sgml-omittag: nil
0122 End:
0123 -->