openoffice-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache OpenOffice Community > Details on Scenario 3
Date Mon, 12 Nov 2012 01:41:00 GMT
Space: Apache OpenOffice Community (https://cwiki.apache.org/confluence/display/OOOUSERS)
Page: Details on Scenario 3 (https://cwiki.apache.org/confluence/display/OOOUSERS/Details+on+Scenario+3)


Edited by Ricardo Berlasso:
---------------------------------------------------------------------
h1. {color:red}DRAFT{color}

Scenario 3 (Start from scratch under ALV2 License), even being difficult gives the chance
to do it on a different way than all previous documentation efforts: AOO is a highly integrated
suite with lot of stuff in common on all apps so, if done right, starting from scratch can
provide a flexible framework that will make document maintenance more easy.

This child page for "User Guides Revisited" is an attempt to think about this new structure
for user documentation.

h2. Basics plus examples

We can start from the very basic, highlighting common features between all apps. The very
beginning for the user guides should talk about those common features and how handle them
and only when the basis are set, provide examples for each app.

h3. General description for UI elements

Menus
Toolbars
Dockers
...

Each entry with a sublevel on how to use and customize them. Once the generalities are provided,
it's time for examples. Those examples need to go from the general to the particular: after
all, the default Standard toolbar is almost the same on all AOO apps.

h3. How everything works

A "theoretical" comparison between direct formatting and styles, and why styles are preferred.

A description of what templates are and why they are useful. Highlight the fact that on AOO
makes extensive use of styles.

Quick examples of style and template definition on main AOO apps (Writer, Calc, Draw/Impress)

h2. Now, to the detail

With that background, it is now possible to start with each app documentation. At this point
it will be a lot easier to explain how styles work on Writer (the next style/linked with/etcetera
property) or any other app.

h3. Task oriented documentation

A common scenario implies working on several components at the same time. It is now the moment
to explain how to transfer data from one app to the other (OLE, DDE links...), how to work
with a chart on Calc or Writer, how to pick data from databases...

h3. Advanced features

Graphite fonts
Master documents
Mail merge

h2. BASE Features

Using Base with the embedded HSQLDB and as a front end to other RDB's

...

Anything else?

h1. Proposed TOC

# *General concepts on Apache OpenOffice*: a general introduction to the suite, talking about
common points and not about particular apps. This first chapter must remain as general as
possible in order to be used as reference on the rest of the document. 
## *Apache OpenOffice user interface*: Beside some sample screenshots there is no
need to talk about specific toolbars/menus/... 
### *main menus*: commenting the similarities between different apps (8 menus have the same
names...). Modifying/creating menus.
### *contextual menus* 
### *Toolbars*: normal and contextual toolbars, anchored and floating, how to anchor / modify
/ create new ones / saving toolbars on the profile or on a document... 
### *Status bar*: information provided, functions offered. Let the details for the corresponding
chapters of each component. 
### *Dockers*: how to dock/undock/move/hide/show them, everything on a "neutral" fashion.
Do not describe the dockers but how to move them. 
### *Keyboard shortcuts*: configuring them
## *Formatting a document*: general concepts about direct formatting vs. styles / how styles
are managed / templates
## *Autocorrect options*: a general introduction followed by some notes about the differences
between apps. 
## *Supported file formats*: file types, picture formats... 
## *Extensions*: the extension manager and the repository. Comment that dictionaries are installed
as extensions... 
# *Writer* Here we start with each app. This and the following chapters should take
the first one as granted. 
## *Knowing Writer*: an introduction to direct formatting tools. Make clear that page do not
support direct formatting but only the use of styles (Format → Page just edit the current
page style) and point the reader to the page style section on the guide. 
### *Editing text* Tools for paragraph and character formatting. Indicate that language
as direct formatting is a character property. Fist steps on numbered lists and bullets, indicating
the use of the corresponding toolbar / alignment and indents on numbered lists. 
### *Tables on Writer* Insert / format them. 
### *Inserting pictures and OLE objects* Different options, embed vs.
linked, supported formats
### *Frames* Manually insert frames, their properties: anchoring / wrap / positioning
/ number of columns / the "follow text flow" option / linked frames... 
### *Sections* What sections are, columns, protect their content, link to other files... 
### *Autotexts* defining and using autotexts
## *Styles on Writer* Main characteristics for Writer styles: linked with, followed
by...
### *Paragraph and character styles* Treat them on the same section, as they are
quite similar. Insists on the use of styles to define the language for the text. Quick note
on "breaks" option on text flow tab for paragraph styles, indicating that this will be considered
on the page styles section. Same with "page register" option under indents and spacing tab
### *Frame styles* As most about about frames was told on 2.a.iv, show what you _cannot_
control with frame styles. 
### *Page styles* Configuring/creating page styles, heathers and footers different
on left and right pages, associate an automated page break with a paragraph style, page register... 
### *List styles* How to define them and how to associate a list style with a paragraph
style. .
## *Fields, variables and cross references* Defining and using fields. The Insert
→ Fields → Other dialogue. Warning about the wrong use of "corrections" for page numbers
and similar problems. 
## *Organizing and numbering chapters* A hierarchy of styles using Tools → Outline
numbering and how to number chapter there. Refers to the numbered list configuration when
commenting how to tune the numbering (the dialogues are identical). Adding more styles to
each outline level by editing the paragraph style. Numbering these additional styles with
the use of numbered list styles
## *Footnotes and endnotes* Paragraph and character styles used for note anchors,
etc. Indicate how to avoid endnotes ending on a new page with the use of sections. Changing
from footnotes to endnotes and vice-versa. 
## *The navigator* Localizing and moving things around
## *Table of contents and indexes* Defining and modifying TOC and other indexes. 
## *Master documents* 
# *Calc*: follow a similar structure than Writer (direct tools, then styles, then going for
more detail)
# *Impress* 
# *Draw* 
# *Math* 
## *Using Math on other components*: enforcing the idea that Math was not designed to be used
standalone. 
## *Math syntax elements* operators, symbols...
## *Cofiguring Math* selecting fonts and spacing... 
## *Defining new symbols* 
# *Base* 
# *Advanced topics* 
## *Macros and UNO*: StarBasic, python... 
## *Graphite fonts* extended font names...
# *Integrating components* Talk about the interaction between components. More about
OLE objects. 
## *Mail merge* 
## *Bibliographic database* 
## *Inserting graphs* 
## … 

Change your notification preferences: https://cwiki.apache.org/confluence/users/viewnotifications.action
  

Mime
View raw message