Difference between revisions of "Documentation/Dashboard/Producing User Guides"
From Apache OpenOffice Wiki
< Documentation | Dashboard
m |
(Added details for "Publish a chapter") |
||
| Line 26: | Line 26: | ||
** Use sections | ** Use sections | ||
| − | + | ==Publish a chapter== | |
| + | <p>When you have decided that a chapter is ready for publishing, do the following:</p> | ||
| + | <ol> | ||
| + | <li>Make a final pass to check page breaks and make any necessary changes. (Use the keep-with-next attribute, not manual page breaks, and/or change the sequence of text and figures.)</li> | ||
| + | <li>Verify that the first item in the first numbered list in the chapter is explicitly set to start at 1 (this is to make sure the chapter works properly when it is a subdocument in a master document for a compiled book). To do this:</li> | ||
| + | <ol style="list-style-type: lower-alpha"> | ||
| + | <li>Right-click on the first list paragraph and choose <b>Paragraph</b>.</li> | ||
| + | <li>Go to the Outline & Numbering tab. In the Numbering section, select the checkbox for <b>Restart at this paragraph</b> and select the checkbox for <b>Start with</b>, making sure the number is <b>1</b>.</li> | ||
| + | <li>Click <b>OK</b> to save the change.</li> | ||
| + | </ol> | ||
| + | <li>Update the ToC. Make sure there is no (alphabetic) index at the end of the chapter.</li> | ||
| + | <li>On the copyright page, insert the current date and the software version. Verify that the correct email address for OOoAuthors, and the correct URL for published chapters (in the footer), are shown.</li> | ||
| + | <li>Save the ODT file with the correct file name, using the <strong>naming convention for published chapters</strong> (see below).</li> | ||
| + | <li>Export the file to PDF, using these settings:</li> | ||
| + | <ul> | ||
| + | <li>On the General tab, select <b>Export bookmarks</b>.</li> | ||
| + | <li>On the Initial View tab, in the Page layout section, select <b>Continuous facing</b>.</li> | ||
| + | </ul> | ||
| + | <li>Upload both files to the Published Chapters folder for the relevant book, overwriting any files of the same names that are already there, and change their state to "externally visible".</li> | ||
| + | <li>Tell the Authors list that you have published the chapter.</li> | ||
| + | <li>Update the relevant page in [http://oooauthors.org/userguide3/published this folder]. | ||
| + | </li> | ||
| + | <li>Log in to the OpenOffice.org wiki and replace the chapter file (PDF). To do this:</li> | ||
| + | <ol style="list-style-type: lower-alpha"> | ||
| + | <li>Use an address similar to <nowiki>http://wiki.services.openoffice.org/wiki/File:0401DG3-IntroducingDraw.pdf</nowiki> to get to the File History wiki page for the chapter.</li> | ||
| + | <li>Choose <b>Upload a new version of this file</b>.</li> | ||
| + | <li>On the Upload File page, browse for the chapter file, type something in the File Changes box (usually "corrected typos" or "updated for version x.x" or similar is sufficient). Select the Ignore any warnings checkbox and click the <b>Upload file</b> button.</li> | ||
| + | </ol> | ||
| + | <li>Go to the [http://wiki.services.openoffice.org/wiki/Documentation/OOo3_User_Guides/Chapters User Guides page]. Edit that page to show the publication date and file size for the revised chapter.</li> | ||
| + | </ol> | ||
| + | |||
| + | <h3>Naming convention for published chapters</h3> | ||
| + | <p>To ensure that chapters and books are listed correctly on the | ||
| + | Documentation Project's website, file names take the following form: | ||
| + | <br /> | ||
| + | <strong>AABBCC3-Name</strong>, where<br /> | ||
| + | AA=book number, BB=chapter number, CC=book initials, 3=OOoVersion 3, Name=Chapter name.</p> | ||
| + | <p>Book number and initials:<br /> | ||
| + | 01 = GS = Getting Started<br /> | ||
| + | 02 = WG = Writer Guide<br /> | ||
| + | 03 = CG = Calc Guide<br /> | ||
| + | 04 = DG = Draw Guide<br /> | ||
| + | 05 = IG = Impress Guide<br /> | ||
| + | 06 = MG = Migration Guide<br /> | ||
| + | 07 = BG = Database Guide</p> | ||
| + | <p>The chapter or book name is given in full; each word begins with a capital letter and there are no spaces between words.</p> | ||
| + | <p>For example, the third chapter of the Writer Guide, Working with Text, has the following file name:<br /> | ||
| + | 0203WG3-WorkingWithText.pdf</p> | ||
| + | <p><strong>Note:</strong> The "chapter number" for a full book is 00. | ||
| + | Thus the file name for the Getting Started book is<br /> | ||
| + | 0100GS3-GettingStarted.pdf</p> | ||
| + | |||
* Compile and publish a book using a master document | * Compile and publish a book using a master document | ||
[[Category:Documentation/Dashboard]] | [[Category:Documentation/Dashboard]] | ||
Revision as of 22:32, 9 September 2010
Topics for guide to producing OOo user guides (Not necessarily in sequential order)
- Set up OOo memory and view options
- Download and install chapter template
- Download and install Template Changer extension
- Create AutoText entries for Tip, Note, Caution, and data tables
- Create new chapter from template
- Update template from website
- Update chapter file from changed template
- Create screenshots
- Create other illustrations
- Label screenshots and other illos (add callouts)
- Insert images
- Cross-reference to figures, tables, headings
- Cross-reference to other documents
- Insert index entries
- Edit index entries
- Write and edit common topics
- Use variables and other fields
- Use conditional text, hidden paragraphs
- Insert common topics into a chapter
- Use sections
Publish a chapter
When you have decided that a chapter is ready for publishing, do the following:
- Make a final pass to check page breaks and make any necessary changes. (Use the keep-with-next attribute, not manual page breaks, and/or change the sequence of text and figures.)
- Verify that the first item in the first numbered list in the chapter is explicitly set to start at 1 (this is to make sure the chapter works properly when it is a subdocument in a master document for a compiled book). To do this:
- Right-click on the first list paragraph and choose Paragraph.
- Go to the Outline & Numbering tab. In the Numbering section, select the checkbox for Restart at this paragraph and select the checkbox for Start with, making sure the number is 1.
- Click OK to save the change.
- Update the ToC. Make sure there is no (alphabetic) index at the end of the chapter.
- On the copyright page, insert the current date and the software version. Verify that the correct email address for OOoAuthors, and the correct URL for published chapters (in the footer), are shown.
- Save the ODT file with the correct file name, using the naming convention for published chapters (see below).
- Export the file to PDF, using these settings:
- On the General tab, select Export bookmarks.
- On the Initial View tab, in the Page layout section, select Continuous facing.
- Upload both files to the Published Chapters folder for the relevant book, overwriting any files of the same names that are already there, and change their state to "externally visible".
- Tell the Authors list that you have published the chapter.
- Update the relevant page in this folder.
- Log in to the OpenOffice.org wiki and replace the chapter file (PDF). To do this:
- Use an address similar to http://wiki.services.openoffice.org/wiki/File:0401DG3-IntroducingDraw.pdf to get to the File History wiki page for the chapter.
- Choose Upload a new version of this file.
- On the Upload File page, browse for the chapter file, type something in the File Changes box (usually "corrected typos" or "updated for version x.x" or similar is sufficient). Select the Ignore any warnings checkbox and click the Upload file button.
- Go to the User Guides page. Edit that page to show the publication date and file size for the revised chapter.
Naming convention for published chapters
To ensure that chapters and books are listed correctly on the
Documentation Project's website, file names take the following form:
AABBCC3-Name, where
AA=book number, BB=chapter number, CC=book initials, 3=OOoVersion 3, Name=Chapter name.
Book number and initials:
01 = GS = Getting Started
02 = WG = Writer Guide
03 = CG = Calc Guide
04 = DG = Draw Guide
05 = IG = Impress Guide
06 = MG = Migration Guide
07 = BG = Database Guide
The chapter or book name is given in full; each word begins with a capital letter and there are no spaces between words.
For example, the third chapter of the Writer Guide, Working with Text, has the following file name:
0203WG3-WorkingWithText.pdf
Note: The "chapter number" for a full book is 00.
Thus the file name for the Getting Started book is
0100GS3-GettingStarted.pdf
- Compile and publish a book using a master document
