Screen Shots

From Synfig Studio :: Documentation
Jump to: navigation, search
Line 6: Line 6:
 
Screen shots for the documentation should be done in a specific way.
 
Screen shots for the documentation should be done in a specific way.
  
'''basics:'''
+
 
 +
== basics ==
 +
 
 
* Use "Clearlooks" with "Tango" icons for the screenshots (Windows/Mac users use "blue-ish" styles, please)
 
* Use "Clearlooks" with "Tango" icons for the screenshots (Windows/Mac users use "blue-ish" styles, please)
 
* Png format only
 
* Png format only
Line 12: Line 14:
 
* Let's do smart screenshots! A group panel screenshot with no groups in it is meaningless!
 
* Let's do smart screenshots! A group panel screenshot with no groups in it is meaningless!
  
'''partial vs. full window:'''
+
 
 +
== partial vs. full window ==
 +
 
 
* Do not use windows decoration / GUI items if they are not needed.
 
* 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.
 
* Usage of post production tools (blur the non subject areas of the screenshot, text annotations etc.) are welcome.
  
'''appearence in text:'''
+
 
 +
== appearence in text ==
 +
 
 
* Images should be shown in full size when possible. Only if the image takes too much space it might be thumbnailed.
 
* 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.
 
* 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:'''
+
 
 +
== naming ==
 +
 
 
* Uploaded images should have a proper name.  
 
* Uploaded images should have a proper name.  
 
* Images have to be categorized to be found easily.
 
* Images have to be categorized to be found easily.
  
'''samples / sifz source:'''
+
 
 +
== 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).
 
* 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).
  
 +
 +
== more... ==
  
 
We are currently discussing this at the Forum [http://synfig.org/forums/viewtopic.php?f=25&t=1123].
 
We are currently discussing this at the Forum [http://synfig.org/forums/viewtopic.php?f=25&t=1123].

Revision as of 10:29, 27 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
  • High quality at Canvas: Low Resolution checkbox is off, quality is set to 1
  • 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).


more...

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