Warning, /office/calligra/doc/tocs.txt is written in an unsupported language. File is not indexed.
0001 Calligra 2.0 TOC proposal
0002 ------------------------
0003
0004
0005 Preface
0006
0007 This document gives some suggestions about what the Calligra documentation
0008 should contain, in the form of annotated tables of contents. The TOCs have
0009 been compiled from
0010 - thoughts
0011 - the current manual contents
0012 - the guides for OpenOffice.org as published by the OOoAuthors initiative
0013
0014 The current status of the documentation should be available in the file
0015 status.txt in the same directory as this file.
0016
0017 Contributors to this document:
0018 - Sander Koning (Calligra documentation coordinator) <sanderkoning@kde.nl>
0019 - Thomas Zander <zander@kde.org>
0020
0021 Comments and suggestions are more than welcome, either as SVN commits, or as
0022 e-mails to <sanderkoning@kde.nl>.
0023
0024 --------------------------------------------------------------------------------
0025
0026 In general
0027
0028 An application manual should be divided into three (four) parts:
0029
0030 - the first chapters describe base technologies (working with text, working
0031 with frames, working with layers, etc.). Start off with a global
0032 introduction (say, 2 pages) that newbees can read and then skip the rest of
0033 the respective chapter.
0034
0035 - the next couple of chapters are based on use cases, having one chapter per
0036 use case. A use case can be "Create a booklet for my kid with lots of
0037 graphics" (google for "pig in the box" for example).
0038
0039 - the following chapters form the reference guide. Describe the menus,
0040 toolbars, etcetera - in a professional, but legible way.
0041
0042 - if any technical, application-specific information needs to be included, do
0043 so in appendices.
0044
0045 --------------------------------------------------------------------------------
0046
0047 To-do
0048
0049 We still need:
0050 - proper, clear, and serious names for the three main parts
0051 (Working with $APP, Examples, Reference Guide?)
0052 - a standardised way of sectioning the reference guide
0053 - technologies and usecases for all applications
0054
0055 --------------------------------------------------------------------------------
0056
0057 Calligra
0058
0059 Introduction to what Calligra is, how to use the user interface that is common
0060 to all applications, how to set general configuration options, where to get
0061 more information.
0062
0063 Since this handbook describes the overall framework, it may as an exception
0064 derive from the general layout noted above.
0065
0066 What is it / Key features
0067 Goal-driven (not implementation-driven) description of what users can do
0068 with Calligra.
0069 The Calligra Workspace
0070 A short description of how to use the workspace:
0071 - what each application does
0072 - tabbed editing
0073 Working with documents
0074 How to manage Calligra documents
0075 - open, save, print, ...
0076 Menus and toolbars
0077 Description of common menus and toolbars.
0078 Configuration
0079 (If any configuration options are available for KOShell, describe them
0080 here.)
0081 More information
0082 Where to get more information about Calligra
0083 (web sites, mailing lists, ...)
0084
0085 --------------------------------------------------------------------------------
0086
0087 Words
0088
0089 Introduction
0090 Basically a copy of the goals described in the general Calligra handbook.
0091 Working with Calligra Words
0092 Working with text
0093 Styles
0094 linespacing
0095 text features (see character/paragraph style header files for a list)
0096 foot notes
0097 end notes
0098 Working with frames
0099 Styles
0100 Working with pages
0101 when are they auto created
0102 copying of frames concept
0103 page spreads
0104 Working with tables
0105 <usecases>
0106 * Simple text with great layout (default styles)
0107 * Create a 3 column, 2 page 'newspaper' with 2 pictures and using just 1
0108 flow of text - make sure the user never has to create any frames except
0109 for the picture frames.
0110 Reference Guide
0111
0112 --------------------------------------------------------------------------------
0113
0114 Calligra Sheets
0115
0116 Introduction
0117 Basically a copy of the goals described in the general Calligra handbook.
0118 Working with Calligra Sheets
0119 Working with cells
0120 Working with formulas
0121 Working with sheets
0122 <more technologies?>
0123 <usecases>
0124 Reference Guide
0125
0126 --------------------------------------------------------------------------------
0127
0128 Stage
0129
0130 Introduction
0131 Basically a copy of the goals described in the general Calligra handbook.
0132 Working with Calligra Stage
0133 Working with slides
0134 Working with master slides
0135 Working with animations
0136 <more technologies?>
0137 <usecases>
0138 Reference Guide
0139
0140 --------------------------------------------------------------------------------
0141
0142 Karbon
0143
0144 Introduction
0145 Basically a copy of the goals described in the general Calligra handbook.
0146 Working with Karbon
0147 Working with shapes ("objects"?)
0148 Working with effects
0149 <more technologies?>
0150 <usecases>
0151 Reference Guide
0152
0153 --------------------------------------------------------------------------------
0154
0155 KChart
0156
0157 Introduction
0158 Basically a copy of the goals described in the general Calligra handbook.
0159 Working with KChart
0160 Working with charts
0161 Chart types
0162 Axes
0163 <more technologies?>
0164 <usecases>
0165 Reference Guide
0166
0167 --------------------------------------------------------------------------------
0168
0169 KFormula
0170
0171 Introduction
0172 Basically a copy of the goals described in the general Calligra handbook.
0173 Working with KFormula
0174 Working with formulas
0175 <more technologies?>
0176 <usecases>
0177 Reference Guide
0178
0179 --------------------------------------------------------------------------------
0180