[Typo3-dev] General rules for TYPO3 docs

[Peter Kindström]

Hi all!
This is a post about general recommendations when writing TYPO3 
documents. If we get an agreement, I like to put these 
recommendations on the wiki.


=== About the die() section
Here you describe how to find a text in a text editor:
   [CTRL] + [w] + die + [ENTER]
and how to save/exit
   [CTRL] + [x] + y + [ENTER]

As far as I know, these are specific commands for a specific 
editor? If so, I think they should be removed. Maybe if the text 
said somethink like "This is how you do it in XXX editor on 
Linux" it could be ok...

What do you think?


=== About images
In general I think images should not contain any part of the web 
browser window. Normally you should cut your screenshots so that 
just the _page_content_ is seen. In this way we both keep the 
documents slightly smaller and get a document that is web 
browser / operating system neutral.

What do you think?


=== Extract images from SXW documents
And finally a tip: One way of extracting images out of 
OpenOffice documents (SXW) in Windows is to rename the document 
.zip. If you then open the document with your zip program you 
will find the picures in the "Pictures" subfolder. From there 
you can extract then and use them in your own document.


/Peter Kindström