[TYPO3-doc] Screenshot rules and guidelines for Official Documentation

François Suter fsu-lists at cobweb.ch
Fri Jul 9 15:40:06 CEST 2010


Hi all,

Now that we are several people to work on the Official Documentation, we 
need to have a set of rules and guidelines on how to produce 
screenshots. Here's a list of proposals, please comment.

1) Reference web site:
The reference site for all screenshots is the Introduction Package. Make 
sure that you have an instance which you can make the screenshots from.
When installing the Introduction Package please keep the *original* 
background color, so that all screenshots are homogeneous (sorry 
Susanne, no pink ;-) ).

2) Annotating screenshots:
It is ok to annotate/highlight screenshots with numbered circles, 
rectangles and/or arrows. Here are proposed settings (the use of blue is 
based on the screenshots made by Susanne for the Getting Started 
tutorial) (see attached screenshot):

Circles with numbers:
- white border, 2 pixels
- blue background (#0066FF = rgb(0, 102, 255)), 50% transparency
- shadow, black, horizontal offset: 2 pixels, vertical offset: -2 
pixels, blur: 3 pixels, 60% transparency
- text: white, Lucida Grande Regular, 20pt

Highlights using either a rectangle surrounding the desired area or an 
arrow pointing to a specific spot.

Rectangle:
- blue (#0066FF = rgb(0, 102, 255)) border, 2 pixels
- shadow, black, horizontal offset: 2 pixels, vertical offset: -2 
pixels, blur: 3 pixels, 60% transparency

Arrow:
- blue (#0066FF = rgb(0, 102, 255)) stroke, 2 pixels
- shadow, black, horizontal offset: 2 pixels, vertical offset: -2 
pixels, blur: 3 pixels, 60% transparency

3) Screenshot tools:
It is not necessary that everyone uses the same tool for creating the 
screenshots, but the tool should make it possible to achieve the results 
mentioned above.
François: I use Voilà for Mac
Others: what do you use and can you achieve the above-mentioned settings?

The next topic will be how to include screenshots in OO files.

Thanks in advance for your feedback.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch


More information about the TYPO3-project-documentation mailing list