[sdk/codevis] /: Add Initial / Preliminary Docbook documentation
Tomaz Canabrava
null at kde.org
Wed Sep 27 08:58:56 BST 2023
Git commit 7b520bdd08f651fde884e6cb75cc73384d6a2c07 by Tomaz Canabrava, on behalf of Tomaz Canabrava.
Committed on 27/09/2023 at 09:55.
Pushed by tcanabrava into branch 'master'.
Add Initial / Preliminary Docbook documentation
Signed-off-by: Tomaz Canabrava <tcanabrava at kde.org>
M +4 -0 CMakeLists.txt
A +1 -0 doc/CMakeLists.txt
A +10 -0 doc/xml-docbook/CMakeLists.txt
A +52 -0 doc/xml-docbook/configuring.docbook
A +- -- doc/xml-docbook/images/codevis.png
A +123 -0 doc/xml-docbook/index.docbook
A +84 -0 doc/xml-docbook/man-codevis_desktop.1.docbook
https://invent.kde.org/sdk/codevis/-/commit/7b520bdd08f651fde884e6cb75cc73384d6a2c07
diff --git a/CMakeLists.txt b/CMakeLists.txt
index aa1c529..833cb38 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -115,6 +115,8 @@ if (BUILD_DESKTOP_APP)
TextEditor
XmlGui
I18n
+ OPTIONAL_COMPONENTS
+ DocTools
)
if (USE_QT_WEBENGINE)
find_package(Qt${QT_MAJOR_VERSION} REQUIRED COMPONENTS WebEngineWidgets)
@@ -292,6 +294,7 @@ if (BUILD_DESKTOP_APP)
DESTINATION ${CMAKE_INSTALL_LIBDIR}
)
+ add_subdirectory(doc)
add_subdirectory(lvtmdl)
add_subdirectory(lvtclr)
add_subdirectory(lvtqtc)
@@ -325,3 +328,4 @@ install(
DESTINATION
${KDE_INSTALL_DATAROOTDIR}/codevis/database-spec
)
+
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..cb952e6
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1 @@
+add_subdirectory(xml-docbook)
\ No newline at end of file
diff --git a/doc/xml-docbook/CMakeLists.txt b/doc/xml-docbook/CMakeLists.txt
new file mode 100644
index 0000000..2810e29
--- /dev/null
+++ b/doc/xml-docbook/CMakeLists.txt
@@ -0,0 +1,10 @@
+kdoctools_create_handbook(
+ index.docbook
+ INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en
+ SUBDIR codevis
+)
+
+kdoctools_create_manpage(
+ man-codevis_desktop.1.docbook 1
+ INSTALL_DESTINATION ${KDE_INSTALL_MANDIR}
+)
diff --git a/doc/xml-docbook/configuring.docbook b/doc/xml-docbook/configuring.docbook
new file mode 100644
index 0000000..1333d95
--- /dev/null
+++ b/doc/xml-docbook/configuring.docbook
@@ -0,0 +1,52 @@
+<chapter id="configuring-codevis">
+ <chapterinfo>
+ <authorgroup>
+ <author>&Anders.Lund; &Anders.Lund.mail;</author>
+ <!-- TRANS:ROLES_OF_TRANSLATORS -->
+ </authorgroup>
+ </chapterinfo>
+<title>Configuring &codevis;</title>
+
+<sect1 id="configuring-overview">
+ <title>Overview</title>
+<para>
+ <indexterm>
+ <primary>configure</primary>
+ <secondary>settings</secondary>
+ <tertiary>preferences</tertiary>
+ </indexterm>
+ <anchor id="find"/>
+ <anchor id="find-again"/>
+ <!-- <anchor id="print"/> -->
+ <anchor id="replace"/>
+ <!-- <anchor id="save"/> -->
+ <anchor id="undo"/>
+ <anchor id="redo"/>
+
+ &codevis; offers several means of tweaking the application to behave as desired.
+ The most important ones are:
+</para>
+
+<variablelist>
+ <varlistentry>
+ <term id="configure">The Configuration Dialog</term>
+ <listitem>
+ <para>
+ The main configuration tool, allowing you to configure the &codevis; application,
+ the editor component and the usage of plugins.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term id="settings">The <guimenu>Settings</guimenu> Menu</term>
+ <listitem>
+ <para>
+ Allows you to change often used settings, and to
+ launch the configuration dialogs.
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</sect1>
+
+</chapter>
diff --git a/doc/xml-docbook/images/codevis.png b/doc/xml-docbook/images/codevis.png
new file mode 100644
index 0000000..78ddfef
Binary files /dev/null and b/doc/xml-docbook/images/codevis.png differ
diff --git a/doc/xml-docbook/index.docbook b/doc/xml-docbook/index.docbook
new file mode 100644
index 0000000..93bc0e3
--- /dev/null
+++ b/doc/xml-docbook/index.docbook
@@ -0,0 +1,123 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
+"dtd/kdedbx45.dtd" [
+ <!ENTITY gdb "<acronym>GDB</acronym>">
+ <!ENTITY codevis "<acronym>codevis</acronym>">
+ <!ENTITY kparts "<acronym>KParts</acronym>">
+
+ <!ENTITY Tomaz.Canabrava '<personname><firstname>Tomaz</firstname><surname>Canabrava</surname></personname>'>
+ <!ENTITY Tomaz.Canabrava.mail '<email>tcanabrava at kde.org</email>'>
+ <!ENTITY Tarcisio.Fischer '<personname><firstname>Tarcisio</firstname><surname>Fischer</surname></personname>'>
+ <!ENTITY Tarcisio.Fischer.mail '<email>tarcisio.fischer at codethink.co.uk</email>'>
+ <!ENTITY underApache "Apache 2.0 License">
+
+ <!-- If we want more chapters, we copy the configuring one, and adapt. -->
+ <!ENTITY configuring-chapter SYSTEM "configuring.docbook">
+ <!ENTITY % addindex "IGNORE">
+ <!ENTITY % English "INCLUDE"><!-- change language only here -->
+]>
+
+<book id="codevis" lang="&language;">
+<title>The &codevis; Handbook</title>
+
+<bookinfo>
+ <authorgroup>
+ <author>&Tomaz.Canabrava; &Tomaz.Canabrava.mail;</author>
+ <!-- TRANS:ROLES_OF_TRANSLATORS -->
+ </authorgroup>
+ <copyright>
+ <year>2023</year>
+ <holder>&Tomaz.Canabrava;</holder>
+ </copyright>
+ <date>2023-10-22</date>
+ <releaseinfo>Applications 24.00</releaseinfo>
+ <abstract>
+ <para>&codevis; is a Large Scale Software visualizer by &kde;.</para>
+ <para>This handbook documents &codevis; Version 24.00</para>
+ </abstract>
+ <keywordset>
+ <keyword>KDE</keyword>
+ <keyword>kdebase</keyword>
+ <keyword>Codevis</keyword>
+ <keyword>text</keyword>
+ <keyword>editor</keyword>
+ <keyword>programmer</keyword>
+ <keyword>programming</keyword>
+ <keyword>projects</keyword>
+ <keyword>MDI</keyword>
+ <keyword>Multi</keyword>
+ <keyword>Document</keyword>
+ <keyword>Interface</keyword>
+ <keyword>terminal</keyword>
+ <keyword>console</keyword>
+ </keywordset>
+</bookinfo>
+
+<chapter id="introduction">
+ <title>Introduction</title>
+
+ <para>
+ Welcome to &codevis;, a programmer's best friend &kde;.
+ Some of &codevis;'s many features includes software architecture visualization,
+ manipulation, code generation from diagrams, diagrams generation from source code,
+ plugins, static analysis, visual static analysis and much more.
+ </para>
+
+ <para>
+ But &codevis; is more than an architecture helper. Its ability to open
+ several files at once makes it ideal for visualizing different architectures at once,
+ and experimenting. Many architectural issues were found and fixed on &codevis; itself by
+ analyzing it's source code.
+ </para>
+
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata format="PNG" fileref="images/codevis.png"/>
+ </imageobject>
+ <caption>
+ <para>Editing this manual...</para>
+ </caption>
+ </mediaobject>
+ </para>
+
+</chapter>
+
+&configuring-chapter;
+
+<chapter id="credits">
+ <title>Credits and License</title>
+ <para>
+ &codevis;. Program copyright 2023 by the &codevis; developer team.
+ </para>
+
+ <variablelist>
+ <title>The &codevis; team:</title>
+ <varlistentry>
+ <term>&Tomaz.Canabrava; &Tomaz.Canabrava.mail;</term>
+ <listitem>
+ <para>Developer</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>&Tarcisio.Fischer; &Tarcisio.Fischer.mail;</term>
+ <listitem>
+ <para>Developer</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>Documentation copyright 2023 &Tomaz.Canabrava;
+ &Tomaz.Canabrava.mail;</para>
+</chapter>
+</book>
+
+<!--
+Local Variables:
+mode: sgml
+sgml-namecase-general: t
+sgml-namecase-entity: nil
+sgml-general-insert-case: lower
+sgml-minimize-attributes: nil
+sgml-omittag: nil
+End:
+-->
diff --git a/doc/xml-docbook/man-codevis_desktop.1.docbook b/doc/xml-docbook/man-codevis_desktop.1.docbook
new file mode 100644
index 0000000..7d22b78
--- /dev/null
+++ b/doc/xml-docbook/man-codevis_desktop.1.docbook
@@ -0,0 +1,84 @@
+<?xml version="1.0" ?>
+<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
+ <!ENTITY codevis "<acronym>codevis</acronym>">
+ <!ENTITY Tomaz.Canabrava '<personname><firstname>Tomaz</firstname><surname>Canabrava</surname></personname>'>
+ <!ENTITY Tomaz.Canabrava.mail '<email>tcanabrava at kde.org</email>'>
+ <!ENTITY Tarcisio.Fischer '<personname><firstname>Tarcisio</firstname><surname>Fischer</surname></personname>'>
+ <!ENTITY Tarcisio.Fischer.mail '<email>tarcisio.fischer at codethink.co.uk</email>'>
+ <!ENTITY underApache "Apache 2.0 License">
+ <!ENTITY % English "INCLUDE">
+]>
+
+<refentry lang="&language;">
+<refentryinfo>
+ <title>&codevis; User's Manual</title>
+ <author>&Tomaz.Canabrava; &Tomaz.Canabrava.mail;</author>
+ <date>2024-00-00</date>
+ <releaseinfo>KDE Gear 24.00</releaseinfo>
+ <productname>KDE Gear</productname>
+</refentryinfo>
+
+<refmeta>
+<refentrytitle><command>codevis_desktop</command></refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+<refname><command>codevis_desktop</command></refname>
+<refpurpose>Large Scale Software Architectural Visualization by &kde;</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <!-- add a list of command line arguments here. -->
+ <command>codevis_desktop</command>
+ <group choice="opt"><option>--help</option></group>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+<title>Description</title>
+<para>&codevis; is the &kde; Large Scale Software Architectural analysis tool. </para>
+<para>
+ Some of &codevis;'s many features includes software architecture visualization,
+ manipulation, code generation from diagrams, diagrams generation from source code,
+ plugins, static analysis, visual static analysis and much more.
+</para>
+
+<para>
+ But &codevis; is more than an architecture helper. Its ability to open
+ several files at once makes it ideal for visualizing different architectures at once,
+ and experimenting. Many architectural issues were found and fixed on &codevis; itself by
+ analyzing it's source code.
+</para>
+
+</refsect1>
+
+<refsect1>
+ <title>Options</title>
+ <variablelist>
+ <!-- Add more entities here with longer explanations -->
+ <varlistentry>
+ <term><option>--help</option></term>
+ <listitem><para>Shows the help and exits</para></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>
+
+<refsect1>
+<title>See Also</title>
+
+<simplelist><member>More detailed user documentation is available from <ulink
+url="help:/codevis">help:/codevis</ulink>
+(either enter this &URL; into a web-browser;, or run
+<userinput><command>khelpcenter</command>
+<parameter>help:/codevis</parameter></userinput>).</member>
+<member>kf5options(7)</member>
+<member>qt5options(7)</member>
+<member>There is also further information available at the <ulink
+url="https://invent.kde.org/sdk/codevis/">&codevis; website</ulink>.
+</member>
+</simplelist>
+</refsect1>
+
+</refentry>
More information about the kde-doc-english
mailing list