File: purpose.xml

package info (click to toggle)
pdfedit 0.4.1-2
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 15,032 kB
  • ctags: 21,708
  • sloc: cpp: 185,471; xml: 8,824; yacc: 1,178; ansic: 666; perl: 664; makefile: 636; sh: 371; lisp: 51
file content (41 lines) | stat: -rw-r--r-- 1,428 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<!-- vim:tabstop=4:shiftwidth=4:noexpandtab:textwidth=80 
-->
<part id="document_purpose">
    <title>Document purpose</title>
	<para>
		This document describes design and internals of PDFedit program intended 
		for PDF documents manipulation. It doesn't bring precise code or 
	    classes description but rather provides ideas and general
	    information to understand the implementation. If somebody wants to
	    use or reuse this project or understand current state he/she 
	    should start with this document and then follow with 
	    automatically generated doxygen programming documentation.
	</para>
	<sect1 id="document_organization">
	    <title>Document organization</title>
	    <para>
		Document itself is divided into several parts:
		<itemizedlist>
		    <listitem>
			<xref linkend="general_part"/> which focuses on global 
			application design, separation to layers, general utils
			common for all layers and cooperation and integration
			with xpdf project.
		    </listitem>
		    <listitem>
			<xref linkend="kernel_part"/> which focuses on 
			detailed kernel architecture and interface for gui 
			description.
		    </listitem>
		    <listitem>
			<xref linkend="gui_part"/> which describes gui
			architecture.
		    </listitem>
		    <listitem>
			<xref linkend="glossary_part"/> which describes used
			terms in whole document.
		    </listitem>
		</itemizedlist>
	    </para>
	</sect1>
</part>