← Back to branch summary

~ubuntu-branches/ubuntu/breezy/koffice/breezy

« back to all changes in this revision

Viewing changes to kword/HACKING

  • Committer: Bazaar Package Importer
  • Author(s): Ben Burton
  • Date: 2004-05-09 11:33:00 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040509113300-vfrdadqsvjfuhn3b
Tags: 1:1.3.1-1
http://bugs.debian.org/246623
http://bugs.debian.org/246209
http://bugs.debian.org/221256
http://bugs.debian.org/227568
* New upstream bugfix release.
* Built against newer imagemagick (closes: #246623).
* Made koffice-libs/kformula recommend/depend on latex-xft-fonts, which
  provides mathematical fonts that the formula editor can use.  Also
  patched the kformula part to make these fonts the default.
* Changed kword menu hint from "WordProcessors" to "Word processors"
  (closes: #246209).
* Spellchecker configuration is now fixed (closes: #221256, #227568).

Show diffs side-by-side

added added

removed removed

Lines of Context:
kword/HACKING
 
1
This is an outline of the files and directories in kword.
 
2
(actual state of 2003-07-23)
 
3
 
 
4
DIRECTORIES:
 
5
  dtd:
 
6
    the DTD definition for the kword file format
 
7
    - kword.dtd
 
8
      main document structure
 
9
    - framstyles.dtd
 
10
      borders, background
 
11
    - tablestyles.dtd
 
12
      borders, background and (text)style
 
13
    - tabletemplates.dtd
 
14
      pointers to a tablestyle for the first,
 
15
      last row and column and body
 
16
  pics:
 
17
    application icons
 
18
  horizontalline:
 
19
    - line.png
 
20
      horizontal line picture
 
21
  data:
 
22
    xml template files:
 
23
    - framestyles.xml
 
24
    - tablestyles.xml
 
25
    - tabletemplates.xml
 
26
  demos:
 
27
    various example files for kword
 
28
    (another interesting place for such files is the kofficetests 
 
29
    module in kde cvs):
 
30
    - bidi.kwd
 
31
      variuous multilingual text examples
 
32
    - chapters.kwd
 
33
      demonstrates chapter headers and text spaces
 
34
    - DTPTest.kwt
 
35
      DTP frames template
 
36
    - eurosign.kwd
 
37
      the euro sign in different fonts
 
38
    - flatland.kwd
 
39
      a lengthy (English) text file
 
40
      (Flatland: A Romance of Many Dimensions by Edwin A. Abbott)
 
41
    - frametest.kwd
 
42
      frame/subframe formatting demo
 
43
    - statistics.kwd
 
44
      test cases for KWord's statistics
 
45
  expression:
 
46
    - expression.xml
 
47
      builtin expressions template file
 
48
  filters:
 
49
    currently only contains the old non-compiled code for the "mif"
 
50
    filter
 
51
    has been deprecated in favour of ../filters
 
52
  mailmerge:
 
53
    source to allow merging of a (large) number of email addresses 
 
54
    into a single document
 
55
    subdirectories:
 
56
        kabc:
 
57
            kwmailmerge_kabc.h/cc    - KABC addressbook interface
 
58
        sql:
 
59
            various QTSQL interface implementation files
 
60
            to handle table selection and mailmerge data
 
61
  templates:
 
62
    various page layout templates
 
63
        make_template.pl    - Perl script to create XML templates
 
64
                            - from KWord-saved XML files
 
65
    subdirectories
 
66
    (icons, template frames, and desktop definitions):
 
67
        CardsAndLabels:
 
68
            BusinessCards10.*
 
69
            Labels16.*
 
70
        DTP:
 
71
            Empty.*
 
72
            fax.*
 
73
            SimpleLayout.*
 
74
        Envelopes:
 
75
            EnvelopeC6.*
 
76
            EnvelopeDL.*
 
77
        Wordprocessing:
 
78
            A4.*
 
79
            Letter.*
 
80
            Memo.*
 
81
            PlainText.*
 
82
            TwoColumns.*
 
83
 
 
84
FILES:
 
85
  dcop interface:
 
86
    *IFace.h/cc                 - the dcop interface
 
87
 
 
88
  misc app stuff:
 
89
    main.cc                     - the main
 
90
    kwaboutdata.h               - the appname, authors...
 
91
                                - shared between main.cc and kwfactory.cc
 
92
    kword.rc                    - xml-gui layout
 
93
    kword.desktop               - application .desktop file
 
94
 
 
95
  main document data structures:
 
96
    defs.h                      - various global definitions
 
97
                                - FrameSetType, TypeStructDocItem
 
98
    kwdoc.h/cc                  - classes: command history, child,
 
99
                                  and document (config, defaults, load,
 
100
                                  save, frames helpers, and almost
 
101
                                  everything else that links doc
 
102
                                  with ui)
 
103
  configuration dialogs:
 
104
    kwconfig.h/cc               - config ui
 
105
    configfootnotedia.h/cc      - footnotes configuration
 
106
  core:
 
107
    kwfactory.h/cc              - part factory + about data
 
108
  commands:
 
109
    kwcommand.h/cc              - base classes for undo / redo
 
110
                                - (for core editing functionality)
 
111
  misc ui:
 
112
    kwdrag.h/cc                 - drag & drop and clipboard support
 
113
    resizehandles.h/cc          - ui helper (resize handles)
 
114
  core/ui:
 
115
    app:
 
116
        kwcanvas.h/cc           - canvas (drawing area, mouse event
 
117
                                  handlers)
 
118
        kwview.h/cc             - actions (menus, toolbars)
 
119
                                  and their implementation
 
120
    painting:
 
121
        kwtextparag.h/cc        - KWord's extension of KoTextParag
 
122
                                  (e.g. for load and saving as xml)
 
123
        kwtextdocument.h/cc     - KoTextDocument reimplementation
 
124
        kwanchor.h/cc           - support for inline frames
 
125
        kwanchorpos.h           - (ditto)
 
126
    view mode:
 
127
        kwviewmode.h/cc         - "page mode" / "preview mode" etc.
 
128
    doc outline:
 
129
        docstruct.h/cc          - gui for overall document structure
 
130
    styles:
 
131
        stylenames.cc           - contains builtin style names,
 
132
                                  for translation purposes
 
133
        kwstylemanager.h/cc     - KWStyleManager, extension to KoStyleManager
 
134
                                  (the style editor is in libkotext)
 
135
    advanced editing:
 
136
        kwinserthorizontallinedia.h/cc  - insert hor. line dialog
 
137
        kwinsertpagedia.h/cc    - insert page dialog
 
138
    tables:
 
139
        kwtableframeset.h/cc    - all the table handling
 
140
        kwtabletemplate.h/cc    - holds table templates
 
141
        kwtabletemplateselector.h/cc    - manages table templates/ui
 
142
        kwtablestyle.h/cc           - table styles handlers
 
143
        kwtablestylemanager.h/cc    - table styles manager/ui
 
144
    table dialogs:
 
145
        tabledia.h/cc           - table insertion dialog
 
146
        deldia.h/cc             - table row/column deletion dialog
 
147
        insdia.h/cc             - table row/column insertion dialog
 
148
        splitcellsdia.h/cc      - cell splitting dialog
 
149
        resizetabledia.h/cc     - table resize dialog
 
150
    frames:
 
151
        framedia.h/cc           - frame dialog
 
152
        kwframe.h/cc            - frame, framesets (picture/formula/...),
 
153
                                - framesetedit objects for editing framesets
 
154
        kwframelayout.h/cc      - the frame layout engine for headers/main
 
155
                                  frames/footers/footnotes.
 
156
                                  (this is a helper for KWDoc::recalcFrames)
 
157
        kwtextframeset.h/cc        - text frameset
 
158
        kwformulaframe.h/cc        - formula frames
 
159
        kwpartframeset.h/cc        - frameset containing an embedded object
 
160
    frame styles:
 
161
        kwframestylemanager.h/cc    - manage frame styles
 
162
                                    - (list, preview, etc.)
 
163
        kwframestyle.h/cc        - frame style handling
 
164
        kwimportstyledia.h/cc    - import frame styles
 
165
    pics:
 
166
        kwtextimage.h/cc        - old stuff
 
167
                                - (inline image without frame)
 
168
                                - (not available from the UI,
 
169
                                - only from old files)
 
170
        kwinsertpicdia.h/cc     - insert picture dialog
 
171
 
 
172
  core features:
 
173
    variables:
 
174
        kwvariable.h/cc         - basic document variables
 
175
                                - (Renamed variables.h/cc ???)
 
176
    footnotes:
 
177
        footnotedia.h/cc        - footnote insertion dialog
 
178
        configfootnotedia.h/cc  - footnotes configuration
 
179
    background spell checking:
 
180
        kwbgspellcheck.h/cc
 
181
    contents:
 
182
        contents.h/cc           - table of contents
 
183
    search:
 
184
        searchdia.h/cc          - text find and replace
 
185
 
 
186
  other features:
 
187
    bookmarks:
 
188
        kwcreatebookmarkdia.h/cc    - bookmarks dialogs
 
189
        kwcreatebookmarkdiabase.h/cc    - create a bookmark
 
190
        kwselectbookmarkdiabase.h/cc    - select/rename/delete
 
191
                                        - bookmark
 
192
    mailmerge:
 
193
        mailmerge.h/cc
 
194
        mailmerge_actions.h/cc
 
195
        kwordmailmergedatabaseiface.cc
 
196
        mailmerge_interface.h/cc    - dcop
 
197
        mailmerge_interface_skel.cc - (ditto)
 
198
        kwmailmerge.desktop         - mailmerge .desktop file
 
199
    expressions:
 
200
        kweditpersonnalexpressiondia.h/cc
 
201
    text sorting:
 
202
        sortdia.h/cc            - sort text dialog
 
203
 
 
204
  misc weird files: ;-)
 
205
    kwstyle.h                   - Forwarder to kostyle.h,
 
206
                                - they're the same thing now.
 
207
    dummy.cc                    - empty file to compile as a
 
208
                                - "kdeinit loadable module"
 
209
 
 
210
MISC FILES:
 
211
  Docs, hints, etc.:
 
212
    DESIGN
 
213
    DEBUG
 
214
    TODO
 
215
    HACKING