Synfig Naming Conventions

From Synfig Studio :: Documentation
Jump to: navigation, search
(Undo revision 13398 by Ylaurencio (Talk) (accidental translation))
 
(3 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
<!-- Page info end -->
 
<!-- Page info end -->
 
== Conventions ==
 
== Conventions ==
* '''synfig''': is the command to invoke renderer. It should be written in lowercase and if appear in the wiki it should use some special font only used for commands from the console.
+
* '''synfig''' is the command to invoke the renderer. It should be written in lowercase and if appearing in the wiki it should use some special font only used for commands from the console.
* '''synfigstudio''': is the command used to invoke the GUI. Same comments as for synfig.
+
* '''synfigstudio''' is the command used to invoke the GUI. Same comments as for synfig.
* '''Synfig Project''': it is the name of the project that sums: software, packaging, documentation, website, etc.
+
* '''Synfig Project''' is the name of the project that sums: software, packaging, documentation, website, etc.
* '''Synfig''': it is the general name used to refer to the program used in any article or in the documentation when it doesn't refers specifically to synfig or synfigstudio.
+
* '''Synfig''' is the general name used to refer to the program used in any article or in the documentation when it doesn't refer specifically to synfig or synfigstudio.
* '''Synfig Studio''': It is the name what should be used when referring to the GUI in an article or in the documentation.
+
* '''Synfig Studio''' is the name that should be used when referring to the GUI in an article or in the documentation.
  
  
Line 14: Line 14:
 
The name ''Synfig Animation Studio'' should be removed and one of the names above should be used.
 
The name ''Synfig Animation Studio'' should be removed and one of the names above should be used.
  
Forums, wiki, website, sourceforge, etc. should use the rules from now on.
+
Forums, wiki, website, sourceforge, etc. should use the above rules from now on.
  
  
 
{{Navigation|Writer_Documentation|Meta:Wiki_Structure}}
 
{{Navigation|Writer_Documentation|Meta:Wiki_Structure}}

Latest revision as of 15:18, 9 April 2011

Navigation Navigation:  <<Writer Documentation>>

Conventions

  • synfig is the command to invoke the renderer. It should be written in lowercase and if appearing in the wiki it should use some special font only used for commands from the console.
  • synfigstudio is the command used to invoke the GUI. Same comments as for synfig.
  • Synfig Project is the name of the project that sums: software, packaging, documentation, website, etc.
  • Synfig is the general name used to refer to the program used in any article or in the documentation when it doesn't refer specifically to synfig or synfigstudio.
  • Synfig Studio is the name that should be used when referring to the GUI in an article or in the documentation.


Usage

The name Synfig Animation Studio should be removed and one of the names above should be used.

Forums, wiki, website, sourceforge, etc. should use the above rules from now on.


Navigation Navigation:  <<Writer Documentation>>