The Document Foundation Wiki
 

Documentation/Development

From The Document Foundation Wiki

Jump to: navigation, search


Contents

Documentation Development

The first edition of the LibreOffice user guides are based on the guides from the OpenOffice.org project, originally largely written by the community and all released under copy-left (a fairly new form of copyright) agreements. These documents are in the process of being re-branded and updated for publication as official LibreOffice documentation. The English documentation team and various localization teams are currently using Alfresco as an ECM (Enterprise Content Management) system.

If you would like to join us in our efforts to document LibreOffice, please drop a line at the Documentation Team mailing list, introduce yourself and request a user account for our Alfresco platform. We look forward to hearing from you.

To sign up for the mailing list, please send a blank e-mail message to documentation+subscribe@global.libreoffice.org and follow the instructions that will be mailed back to you.


First steps with the Documentation team

We are writing a Contributors' Guide for the Documentation team. Some of the chapters are available in draft form:

Templates for user guides:

LibreOffice 3.4 and 3.5

LibreOffice 3.3

User Guides

Workflow on ODFAuthors (diagram to be updated; Alfresco workflow is slightly different)
Below is the workflow we are using on Alfresco. But since it is presently not working, we are using the ODFAuthors website. First are the instructions for using ODFAuthors and after it are the instructions for using Alfresco.

Using ODFAuthors website

  1. Create draft doc, upload to Drafts folder for the relevant book.
    1. Create draft document according to:
      1. The latest chapter template (currently LO_3_4_chapter_template.ott)
      2. Producing-LO-userguides.odt.
        1. Naming convention: (name)_initials_date.odt
          1. Multi-word names: no spaces between words and every word begins with a capital. (GettingStartedWithCalc)
          2. Date format: YYYYMMDD (20120215)
          3. Initials:
            1. Draft: initials of the author
            2. Review by another: author's initials_reviewer's initials_.(_DEL_JHW_)
            3. Author's approval of changes: reviewer's initials removed
    2. Uploading drafts to the appropriate draft folder:
      1. Request your user name and password for the ODFAuthors web site from the document team mailing list. (documentation@global.libreoffice.org)
      2. Sign into the ODFAuthors web site.
        1. LibreOffice > English > (appropriate folder for your document) > Drafts. This takes you to the folder your file should be uploaded to.
        2. Click "Add new" and then click File from its menu.
        3. Enter the title and a description of the document
        4. Click the Browse button to tell the website where the file is located on your hard drive.
          1. Click the Save button to upload the file.
        5. Submitting your document for review.
          1. Click "State: Internal draft" and select "Submit for publication". (It changes to "State: Pending review".
          2. Log out.
          3. Report what you have done to the document team mailing list (documentation@global.libreoffice.org)
      3. Downloading a file for review:
        1. Sign into ODFAuthors.
        2. LibreOffice > English > (appropriate folder for your document) > Drafts.
        3. Click the file you want to download. Your browser opens a dialog to download the file.
        4. Change the file's status:
          1. Click "Actions" followed by "Check out".
          2. Click "State: Pending review" and select Retract. (It changes to "State: Internal draft".
      4. Uploading a file after a review:
        1. Sign into ODFAuthors.
        2. LibreOffice > English > (appropriate folder for your document) > Feedback.
        3. Click "Add new" and then click File from its menu.
        4. Enter the title and a description of the document
        5. Click the Browse button to tell the website where the file is located on your hard drive.
          1. Click the Save button to upload the file.
        6. Submitting your document for review.
          1. Click "State: Internal draft" and select "Submit for publication". (It changes to "State: Pending review".)
        7. Change the status of the reviewed document.
          1. Navigate to the Draft folder containing the file you downloaded to review.
          2. Click "Actions" followed by "Check in".
        8. Log out.
          1. Report what you have done to the document team mailing list (documentation@global.libreoffice.org) Generally, the author will review the changes you made accepting or rejecting them individually.

NOTE: The rest of the workflow is the same as the ones below for the Alfresco website.

Using Alfresco website

  1. Create draft doc, upload to Drafts space for relevant book.
    1. Create draft document according to:
      1. The latest chapter template (currently LO_3_4_chapter_template.ott)
      2. Producing-LO-userguides.odt. The latter has the naming convention you should use when naming your document. Follow the naming convention on page 20 for all documents.
    2. Uploading drafts to the appropriate draft folder:
      1. Request your user name and password for the Alfresco web site from the document team mailing list. (documentation@global.libreoffice.org)
      2. Sign into the Alfresco web site.
        1. Repository (at the top) > English (left side) > Documentation > (appropriate folder for your document) > Drafts. This takes you to the folder your file should be uploaded to.
      3. Click the Upload button (at the top) and a pop-up window appears
        1. Click the icon with a sheet of paper and magnifine glass to browse to your draft file on you computer.
        2. Click the “Upload file(s)” button to begin the uploading. (uploading process is shown over the name of your file.)
        3. When the uploading is completed, the Upload file(s) button changes to OK. Click it.
        4. If the uploading fails, try again. (Some times it takes two or three tries to successfully upload a file.)
        5. The file now appears in the draft folder.
    3. Submitting your document for review.
      1. On the right side of the file look for “+More”
      2. Click it to open a drop down list.
      3. Select Submit for review. (The file is moved to the Proofing folder.)
        1. Report what you have done to the document team mailing list (documentation@global.libreoffice.org)
  2. Reviewer checks out draft doc, makes changes with tracking on, checks doc in, promotes to Reviewed space.
  3. Author (or someone else, depending on book & circumstances) revises draft, removes change tracking up to that point, demotes file to Drafts space -- OR skip to Step 5.
  4. Repeat Steps 2 and 3 as needed.
  5. When ready, author (or other) promotes file from Reviewed space to Copyediting/Proofing space.
  6. Copyeditor does job with change tracking on, puts into Feedback.
  7. Author (or other) accepts/rejects edits, puts file into Indexing/Final Layout folder, marks as ready for further work.
  8. Indexer/Book Coordinator/whoever final checks all and puts file into Published folder (or returns to Feedback for further work).
  9. Book Coordinator/Publisher/whoever outputs file into various formats (PDF, others to be decided) and makes available to public, with a copy into the working folder for next revision.

If you have any questions, remember Documentation Team mailing list and #documentfoundation at irc.freenode.net.

When you are working on a chapter, please place your initials (or your wiki user ID) in the appropriate column of the tables below. When you are done, please add the date when you returned the file to Alfresco.

For more information on how to review and update LibreOffice user guides (including image creation, cross-referencing, indexing, and publishing), please see Producing LibreOffice User Guides.


Getting Started Guide

The LO v3.3 edition of this book has been published. The LO v3.4 edition of this book is in the final stages of proofing.

TO DO: Update to LO 3.5, as noted in list below. See 3.5 New Features and Fixes for more info. Most items on that page go into other guides or are too detailed or behind-the-scenes for user guides; use judgment).

The list below is a work in progress. Feel free to add items yourself.

General: On copyright page of each chapter:

Chapter 1 (Intro)

Chapter 2 (Setup)

Chapter 3 (Styles & Templates)

Chapter 4 (Writer)

Chapter 5 (Calc)

Chapter 6 (Impress)

Chapter 7 (Draw)

Chapter 8 (Base)

Chapter 9 (Math)

Chapter 10 (Printing etc)

Chapter 11 (Graphics)

Chapter 12 (Web Pages)

Chapter 13 (Macros)

Chapter 14 (Customizing)

Appendix A (Shortcuts)

Appendix B (Open Source)


Status of tasks

Chapter Draft/updated Reviewed Edit/proof Published Checkout
1 Introducing LO
2 Setting Up LO
3 Styles & Templates  
4 Writer
5 Calc
6 Impress
7 Draw
8 Base
9 Math
10 Printing
11 Graphics
12 Web Pages
13 Macros
14 Customizing
A Shortcuts
B Open Source


Writer Guide

The first edition of this book, for LO 3.3, has been published.

The second edition of this book, for LO 3.4, has been published.

TO DO: Update to LO 3.5, replace screenshots and other figures as needed. Include any enhancements or corrections that have been identified.

General:

Chapter 1 (Intro)

Chapter 2 (Setup)

Chapter 3 (Text)

Chapter 4 (Page Layout)

Chapter 5 (Printing etc)

Chapter 6 (Intro to Styles)

Chapter 7 (Working with Styles)

Chapter 10 (Templates)

Appendix A (Keyboard Shortcuts)

Status of tasks

Chapter Draft/updated Reviewed Edit/proof Published Checkout
1 Intro
2 Setup
3 Text
4 Format Pages
5 Printing
6 Intro Styles
7 Work with Styles  
8 Graphics
9 Tables
10 Templates
11 Mail Merge
12 TOCS, Indexes
13 Master Docs
14 Fields
15 Forms
16 Customizing
A Shortcuts

Calc Guide

The first edition of this book, for LO 3.3, has been published.

TO DO: Update to LO 3.4, replace screenshots and other figures as needed.

General:

Chapter 1 (Intro)

Chapter 2 (Data Entry etc.)

Chapter 3 (Charts and Graphs)

Chapter 4 (Styles & Templates)

Chapter 9 (Data Analysis)

Chapter 10 (Linking)

Chapter 13 (Calc as D/B)

Chapter 14 (Setup & Customizing)


Status of tasks

Chapter Draft/updated Reviewed Edit/proof Published Checkout
1 Intro GX 1 Dec 2011
GX 14 Dec
JHW 5 Dec;
returned to GX
GX 5 Dec
2 Enter Edit Format Data GX 1 Dec
3 Charts & Graphs
4 Styles & Templates
5 Graphics
6 Printing
7 Formulas & Functions
8 DataPilot (now Pivot Tables) Martin Fox
9 Data Analysis
10 Linking Calc Data
11 Sharing & Reviewing
12 Calc Macros
13 Simple Database
14 Customizing
A Shortcuts
B Function Descr
C Error Codes


Impress Guide

The first edition of this book, for LO 3.3, has been published.

To do: update to LO 3.4, replace screenshots and other figures as needed.

General:

Chapter 2 (Slide masters, style & templates))

Chapter 7 (Spreadsheets, Charts, etc)

Chapter 10 (Printing, Exporting, etc)

Chapter 11

Status of tasks

Chapter Draft/updated Reviewed Edit/proof Published Checkout
1 Intro Feb 2012
2 Slide Masters Feb 2012
3 Text Feb 2012
4 Pictures Feb 2012
5 Manage Objects Feb 2012
6 Format Objects Mar 2012 (v3.5)
7 Spreadsheets
8 Slides Notes Handouts
9 Slide Shows
10 Customizing
A Shortcuts


Draw Guide

The first edition of this book, for LO 3.3, has been published.

TO DO:

Update to 3.4

General:

Chapter 6 (Pictures)


Chapter Draft/updated Reviewed Edit/proof Published Checkout
1 Intro
2 Basic Shapes
3 Objects
4 Object Attributes
5 Combining
6 Edit Pictures
7 3D Objects
8 Tips & Tricks
9 Flowcharts
10 Advanced


Update to 3.5

General: see above (3.4)

Actual Software Updates: see Wiki (ReleaseNotes/3.5#Impress.2FDraw) and Website (http://www.libreoffice.org/download/3-5-new-features-and-fixes/)

Math Guide

The first edition of this book, for LO 3.3, has been published.

TO DO: Update to LO 3.4, as needed.


General: Use files in Drafts folder for the book. Use the Template Changer extension to apply the v3.4 chapter template (LO_3_4_chapter_template.ott, available from the Documentation > Resources folder in Alfresco).


Chapter Draft/updated Reviewed Edit/proof Published Checkout
Full book


Base Guide

General: Use files in Drafts folder for the book. Use the Template Changer extension to apply the v3.4 chapter template (LO_3_4_chapter_template.ott, available from the Documentation > Resources folder in Alfresco).

To Do:

Chapter Draft/updated Reviewed Edit/proof Published Checkout
1 Introducing Base DEL 10 Nov 2011,
DEL 29 Nov 2011
HZ 17 Nov 2011,
JHW 28 Nov 2011
JHW 1 Dec 2011
2 Planning/Designing your Database DEL
3 Data Input and removal
4 Data Output
5 Exchanging Data
6 Customizing your Database Design
7 More Customization
8 Using Base at Work
Appendix I Build the Example Database
Appendix II Overview of a Database
Appendix III Further Reading on Database Design
Appendix IV Editing the Base Document File


Other Documents

Below are a few of the other documents to be developed.

Administrators' Guide

Could be based on the OpenOffice.org Admin Guide.

Basic Programmers' Guide

Could be based on the OpenOffice.org BASIC Programmers' Guide.

Developers' Guide

Could be based on the OpenOffice.org Developers' Guide.

What To Do When Rebranding

Below is a summary of the things to do during rebranding of an OOo doc to LO. See How to rebrand documents from OpenOffice.org to LibreOffice for details.




Personal tools
Namespaces
Variants
Actions
Wiki
Navigation
Toolbox
donate