There are a few important points to make about writing documentation for TYPO3 in Open Office. Please makes sure to follow these.
When you insert images you can either:
Make a copy/paste from eg. Photoshop, but it's REALLY IMPORTANT that you insert the image into Open Office by the menu “Edit > Paste Special” and then select “Bitmap”. If you don't do it in this way the image cannot be shown (since it will not be stored as a PNG internally in the SXW file)
Alternatively you can use the traditional way “Insert > Graphics > From file” and insert an image from your harddrive. In particular use this if the image is photographic (JPG) since the internal storage as PNG is not good for photographs.
Generally please use copy/paste only for screendumps with large areas of similar color (good png-compression) and JPG-files for photographic images. Go for small images, 72 dpi, medium quality.
Use the paragraph style “Text body” for bodytext
Use “Heading 1” to “Heading 5” for headers. “Heading 1-3” will be recognized as “sections” on typo3.org. “Heading 4-5” is subheaders, where “Heading 5” is preferrably for “Examples”.
For code listings, use the style “Preformatted Text” (found under “HTML Styles”). For codelistings in tables there is a custom style called “Table Contents/PRE”.
This screenshot shows the only paragraph styles allowed in the documents. The ones grayed out are paragraph styles that are used by default for such as the index table or the footer. The others are the ones you are allowed to use.
There are three fields of meta-data you have to fill in. First of all go to “File > Properties...”.
In the “Description” screen you enter the title of the document. Extension manuals are prefixed “EXT: [extension title]”
In the “User defined” screen you enter your email address as the first field (named “Email” / ”Info 1”)
In the “User defined” screen you enter your full name as the second field (named “Author” / ”Info 2”)
Finally you should also insert the correct extension key in the text below the document title, but this is not a meta-data field, just regular text.
