KOffice 2.0 TOC proposal ------------------------ Preface This document gives some suggestions about what the KOffice documentation should contain, in the form of annotated tables of contents. The TOCs have been compiled from - thoughts - the current manual contents - the guides for OpenOffice.org as published by the OOoAuthors initiative The current status of the documentation should be available in the file status.txt in the same directory as this file. Contributors to this document: - Sander Koning (KOffice documentation coordinator) - Thomas Zander Comments and suggestions are more than welcome, either as SVN commits, or as e-mails to . -------------------------------------------------------------------------------- In general An application manual should be divided into three (four) parts: - the first chapters describe base technologies (working with text, working with frames, working with layers, etc.). Start off with a global introduction (say, 2 pages) that newbees can read and then skip the rest of the respective chapter. - the next couple of chapters are based on use cases, having one chapter per use case. A use case can be "Create a booklet for my kid with lots of graphics" (google for "pig in the box" for example). - the following chapters form the reference guide. Describe the menus, toolbars, etcetera - in a professional, but legible way. - if any technical, application-specific information needs to be included, do so in appendices. -------------------------------------------------------------------------------- To-do We still need: - proper, clear, and serious names for the three main parts (Working with $APP, Examples, Reference Guide?) - a standardised way of sectioning the reference guide - technologies and usecases for all applications -------------------------------------------------------------------------------- KOffice Introduction to what KOffice is, how to use the user interface that is common to all applications, how to set general configuration options, where to get more information. Since this handbook describes the overall framework, it may as an exception derive from the general layout noted above. What is it / Key features Goal-driven (not implementation-driven) description of what users can do with KOffice. The KOffice Workspace A short description of how to use the workspace: - what each application does - tabbed editing Working with documents How to manage KOffice documents - open, save, print, ... Menus and toolbars Description of common menus and toolbars. Configuration (If any configuration options are available for KOShell, describe them here.) More information Where to get more information about KOffice (web sites, mailing lists, ...) -------------------------------------------------------------------------------- KWord Introduction Basically a copy of the goals described in the general KOffice handbook. Working with KWord Working with text Styles linespacing text features (see character/paragraph style header files for a list) foot notes end notes Working with frames Styles Working with pages when are they auto created copying of frames concept page spreads Working with tables * Simple text with great layout (default styles) * Create a 3 column, 2 page 'newspaper' with 2 pictures and using just 1 flow of text - make sure the user never has to create any frames except for the picture frames. Reference Guide -------------------------------------------------------------------------------- KSpread Introduction Basically a copy of the goals described in the general KOffice handbook. Working with KSpread Working with cells Working with formulas Working with sheets Reference Guide -------------------------------------------------------------------------------- KPresenter Introduction Basically a copy of the goals described in the general KOffice handbook. Working with KPresenter Working with slides Working with master slides Working with animations Reference Guide -------------------------------------------------------------------------------- Kexi Introduction Basically a copy of the goals described in the general KOffice handbook. Working with Kexi Working with databases Working with forms Reference Guide -------------------------------------------------------------------------------- Kivio Introduction Basically a copy of the goals described in the general KOffice handbook. Working with Kivio Working with stencils Working with stencil sets Reference Guide -------------------------------------------------------------------------------- Karbon14 Introduction Basically a copy of the goals described in the general KOffice handbook. Working with Karbon Working with shapes ("objects"?) Working with effects Reference Guide -------------------------------------------------------------------------------- Krita Introduction Basically a copy of the goals described in the general KOffice handbook. Working with Krita Working with painting tools Working with filters Working with selections Working with layers Reference Guide -------------------------------------------------------------------------------- KPlato Introduction Basically a copy of the goals described in the general KOffice handbook. Working with KPlato Working with tasks Working with dependencies Reference Guide -------------------------------------------------------------------------------- KChart Introduction Basically a copy of the goals described in the general KOffice handbook. Working with KChart Working with charts Chart types Axes Reference Guide -------------------------------------------------------------------------------- KFormula Introduction Basically a copy of the goals described in the general KOffice handbook. Working with KFormula Working with formulas Reference Guide --------------------------------------------------------------------------------