User Tools

Site Tools


wiki_writing_guidelines

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
wiki_writing_guidelines [2018/08/24 20:32]
icke_siegen
wiki_writing_guidelines [2018/08/24 20:34] (current)
icke_siegen
Line 11: Line 11:
   - **Downloadable xml files must be ready to run without fault.** If you feel a particular snippet is worth posting then simply post the code without a filename (which would make it a downloadable file), or give it a txt extension. There must be no xml file which only holds fragments, incomplete xml syntax etc.   - **Downloadable xml files must be ready to run without fault.** If you feel a particular snippet is worth posting then simply post the code without a filename (which would make it a downloadable file), or give it a txt extension. There must be no xml file which only holds fragments, incomplete xml syntax etc.
   - Please **avoid redundant entries**. This is not just a collection of macros - there is no point in posting the umpteenth macro which opens some windows which is already described in a bunch of other postings. Instead, put your comments in the discussion section - and if you find something to improve then edit what's already there, possibly with proper annotations.   - Please **avoid redundant entries**. This is not just a collection of macros - there is no point in posting the umpteenth macro which opens some windows which is already described in a bunch of other postings. Instead, put your comments in the discussion section - and if you find something to improve then edit what's already there, possibly with proper annotations.
-  - **Adhere to the templates** (where provided), or copy similar articles and edit to your needs. This make it easier for the casual user as they will find what they seek always at the same spot and in the same context. +  - **Adhere to the templates** (where provided), or copy similar articles and edit to your needs. This makes it easier for the casual user as they will find what they seek always at the same spot and in the same context. 
-  - Try to follow the **naming conventions**. Of course you are free to name your macros however you like on your own machines. But in order to make a more concise impression why not follow the predicate-object-rule:​ name a macro which does something ​with anotherthing '​dosomething toanotherthing'​. A macro which clears the programmer should be named 'Clear Programmer',​ and one which closes all windows should be called 'Close All Windows'​. This is more human-readable. However, the according filenames and macro IDs might me nore object-like (e.g. xyz.macros.programmer.clear or abc.windows.closeAll).+  - Try to follow the **naming conventions**. Of course you are free to name your macros however you like on your own machines. But in order to make a more concise impression why not follow the predicate-object-rule:​ name a macro which does something ​to anotherthing '​dosomething toanotherthing'​. A macro which clears the programmer should be named 'Clear Programmer',​ and one which closes all windows should be called 'Close All Windows'​. This is more human-readable. However, the according filenames and macro IDs might be nore object-like (e.g. xyz.macros.programmer.clear or abc.windows.closeAll).
  
 These guidelines are work in progress - let us know if you feel they should be updated or amended. These guidelines are work in progress - let us know if you feel they should be updated or amended.
wiki_writing_guidelines.txt · Last modified: 2018/08/24 20:34 by icke_siegen