Screen Shots

From Synfig Studio :: Documentation
Jump to: navigation, search
(Fix navigation links)
(added rules from forum discussion)
Line 5: Line 5:
  
 
Screen shots for the documentation should be done in a specific way.
 
Screen shots for the documentation should be done in a specific way.
We are currently discussing this at the Forum [http://synfig.org/forums/viewtopic.php?f=25&t=1123].
 
  
As soon as the discussion begins to settle we will add the results here.
+
Basics:
 +
* Use "Clearlooks" with "Tango" icons for the screenshots (Windows/Mac users use "blue-ish" styles, please)
 +
* Png format only
 +
* Let's do smart screenshots! A group panel screenshot with no groups in it is meaningless!
  
For the time being it's a good idea to at least read the Forum entries and stick to the obvious points.
+
partial vs. full window
 +
* Do not use windows decoration / GUI items if they are not needed.
 +
* Usage of post production tools (blur the non subject areas of the screenshot, text annotations etc.) are welcome.
 +
 
 +
Appearence in text:
 +
* Images should be shown in full size when possible. Only if the image takes too much space it might be thumbnailed.
 +
* Position: Right align for images if they are near the text - that way they do not interrupt text flow. Center images for "standalone" ones.
 +
 
 +
Naming:
 +
* Uploaded images should have a proper name.
 +
* Images have to be categorized to be found easily.
 +
 
 +
Samples / sifz source:
 +
* When creating sample files showing the effects of the layer's parameter modifications a sifz file must be provided to be sure that the same figure can be rendered again if the window decoration or gui layout is significatively different. Use a meaning name like the screen shot image files (see above).
 +
 
 +
 
 +
We are currently discussing this at the Forum [http://synfig.org/forums/viewtopic.php?f=25&t=1123].

Revision as of 14:06, 20 April 2010

Navigation Navigation:  <<Writer Documentation>>


Screen shots for the documentation should be done in a specific way.

Basics:

  • Use "Clearlooks" with "Tango" icons for the screenshots (Windows/Mac users use "blue-ish" styles, please)
  • Png format only
  • Let's do smart screenshots! A group panel screenshot with no groups in it is meaningless!

partial vs. full window

  • Do not use windows decoration / GUI items if they are not needed.
  • Usage of post production tools (blur the non subject areas of the screenshot, text annotations etc.) are welcome.

Appearence in text:

  • Images should be shown in full size when possible. Only if the image takes too much space it might be thumbnailed.
  • Position: Right align for images if they are near the text - that way they do not interrupt text flow. Center images for "standalone" ones.

Naming:

  • Uploaded images should have a proper name.
  • Images have to be categorized to be found easily.

Samples / sifz source:

  • When creating sample files showing the effects of the layer's parameter modifications a sifz file must be provided to be sure that the same figure can be rendered again if the window decoration or gui layout is significatively different. Use a meaning name like the screen shot image files (see above).


We are currently discussing this at the Forum [1].