~ubuntu-branches/ubuntu/intrepid/cdcover/intrepid

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Bazaar Package Importer
  • Author(s): Roberto Suarez Soto
  • Date: 2002-02-16 19:48:42 UTC
  • Revision ID: james.westby@ubuntu.com-20020216194842-reozknh190rv1w88
Tags: upstream-0.9.1
ImportĀ upstreamĀ versionĀ 0.9.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
HACKING
 
2
-------
 
3
 
 
4
This file is for every hacker who wants to reuse
 
5
some code of the ccc-program or who wants to
 
6
make improvements or bugfixes. Read this text first.
 
7
 
 
8
 
 
9
 
 
10
STRINGLIB
 
11
 
 
12
The ccc program makes heavy use of the c++-classes
 
13
"Bytevector" and "Stringlist", which are defined
 
14
in bytevector.cc and stringlist.cc.  I don't like
 
15
the stirng-class of the c++ standard library, so I
 
16
have written my own. 
 
17
You can use these classes as black boxes. 
 
18
They are well tested and should work properly.
 
19
Take a look to the header files "bytevector.h" 
 
20
and "stringlist.h" to get information about available
 
21
functions. Only very few functions are needed in ccc.
 
22
 
 
23
 
 
24
TEXT2H
 
25
 
 
26
text2h is a little program which converts textfiles
 
27
into c++ header files with "char* argv[]" vector
 
28
constants. See text2h.cc for the source code.
 
29
This tool is used to create the string-ressource
 
30
files, which are used to include the tex-templates
 
31
and the ccc-ressources.
 
32
 
 
33
CCC
 
34
 
 
35
The ccc program consists of the following files:
 
36
 
 
37
ccc.cc        - main program, parameter, error messages
 
38
cccpara.h     - ccc parameters
 
39
cccpara2.h    - ccc parameters WITHOUT value
 
40
                These two files are needed by ccc.cc
 
41
                                for parameter-parsing
 
42
 
 
43
texmaker.h    - cover class interface is defined here
 
44
texmaker.cc   - implementation of the cover class                
 
45
res*.h        - c++ headers with latex template constants  
 
46
                created from the texfiles by the text2h utility
 
47
 
 
48
 
 
49
Check especially the "texmaker.*" files, if you want 
 
50
to reuse the cover-generator in other applications.
 
51
 
 
52
If you have special questions or if you have made
 
53
improvements feel free to contact me:
 
54
 
 
55
ccc-author:
 
56
Ulli Meybohm : ulli@meybohm.de