home tune search software learn abc discuss about blog Starbound/LOTRO contact  

  [abc standard: home | current | route-map | updating | proposals]

 

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
abc:standard:updating [2012/08/15 05:47]
cwalshaw
abc:standard:updating [2013/03/05 17:05]
cwalshaw
Line 3: Line 3:
 The abc standard is open to new [[abc:​standard:​proposals|proposals]] from anyone, although proposals require **support from the abc user community** before being incorporated. The abc standard is open to new [[abc:​standard:​proposals|proposals]] from anyone, although proposals require **support from the abc user community** before being incorporated.
  
-The aim of the process is to provide an inclusive, transparent and considered method for updates to progress (and a procedure which doesn'​t have the bottleneck of requiring my input at every stage).+The aim of the following ​process is to provide an inclusive, transparent and considered method for updates to progress (and a procedure which doesn'​t have the bottleneck of requiring my input at every stage)
 + 
 +=== (Draft) Guidelines for proposal === 
 + 
 +//In order of importance//,​ the aims for any new syntax are that it should result in abc code which is **clear**, **suggestive** and **compact**;​ furthermore,​ the syntax should be **unique**, if possible, and its description in the standard should be **concise** and **straightforward**. 
 + 
 +Specifically:​ 
 +  - the resulting abc code should be as **clear** as possible to humans, preferably without requiring the reader to look up the usage in the standard 
 +  - the resulting abc code should be **suggestive** of standard staff notation, provided that this does not compromise (1) 
 +  - the resulting abc code should be as **compact** as possible, provided that this does not compromise (1) and (2) 
 +  - the syntax should, where possible, be **unique**, provided that this does not compromise (1), (2) and (3) 
 +  - the description of the syntax should be **concise**,​ i.e. giving a lot of information clearly and in a few words, and **straightforward**,​ i.e. uncomplicated and easy to understand, provided that this does not compromise (1), (2), (3) and (4) 
 + 
 +This means that, for example, minimising the size of the abc code is not the first priority if it reduces clarity and suggestiveness. It also means that it is acceptable to have two methods of achieving the same effect, particularly if it helps clarity.
  
 === Submitting a proposal === === Submitting a proposal ===
Line 9: Line 22:
 The process for submitting a proposal is as follows: The process for submitting a proposal is as follows:
   - **Very important** - before doing anything else, make sure that there is some interest from the abc user community in supporting the proposal. Currently the best way to do this is by discussing it on the [[http://​groups.yahoo.com/​group/​abcusers/​|abcusers mailing list]]. You should also familiarise yourself with the abc standard [[abc:​standard:​route-map|route-map]] to make sure your proposal fits in with the general principles and direction of the standard.   - **Very important** - before doing anything else, make sure that there is some interest from the abc user community in supporting the proposal. Currently the best way to do this is by discussing it on the [[http://​groups.yahoo.com/​group/​abcusers/​|abcusers mailing list]]. You should also familiarise yourself with the abc standard [[abc:​standard:​route-map|route-map]] to make sure your proposal fits in with the general principles and direction of the standard.
-  - [[abc:​standard?​do=register|Register]] for an account on the abcnotation wiki.+  - [[abc:​standard?​do=register|Register]] for an account on the abcnotation wiki. Your password will be sent from cwalshaw [at] jdz3 [dot] dailyrazor [dot] com so if you don't get an email shortly, check your spam folder.
   - [[http://​abcnotation.com/​contact|Email me]] with the following information (I will then create a section of the wiki site and give you write access):   - [[http://​abcnotation.com/​contact|Email me]] with the following information (I will then create a section of the wiki site and give you write access):
     * your account username;     * your account username;
Line 29: Line 42:
  
   * The standard is formatted using [[http://​www.dokuwiki.org/​dokuwiki|DocuWiki]],​ a text-based collaborative documentation system that uses "a simple but powerful syntax which makes sure the datafiles remain readable outside the Wiki and eases the creation of structured texts"​. You should also, therefore, use the docuwiki syntax for formatting your proposal. There is a short guide to syntax on the [[http://​www.dokuwiki.org/​syntax|DocuWiki site]] and you can also look at the source text for any abcnotation wiki page by clicking on the "Show pagesource"​ button at the top and bottom of each page (note that if you are logged in, the "Show pagesource"​ button is replaced by an "Edit this page" button for any page which you have permission to modify).   * The standard is formatted using [[http://​www.dokuwiki.org/​dokuwiki|DocuWiki]],​ a text-based collaborative documentation system that uses "a simple but powerful syntax which makes sure the datafiles remain readable outside the Wiki and eases the creation of structured texts"​. You should also, therefore, use the docuwiki syntax for formatting your proposal. There is a short guide to syntax on the [[http://​www.dokuwiki.org/​syntax|DocuWiki site]] and you can also look at the source text for any abcnotation wiki page by clicking on the "Show pagesource"​ button at the top and bottom of each page (note that if you are logged in, the "Show pagesource"​ button is replaced by an "Edit this page" button for any page which you have permission to modify).
-  * To create a new page, just point your browser at the address of the page you require, e.g. <​nowiki>​http://​abcnotation.com/​wiki/​abc:​standard:​v2.1:​proposals:​[your_proposal_name]:​v2</​nowiki>,​ and (if I've got the permissions right) there should be a "​Create this page" button.+  * To create a new page, just point your browser at the address of the page you require, e.g. <​nowiki>​http://​abcnotation.com/​wiki/​abc:​standard:​v2.1:​proposals:​[your_proposal_name]:​[your_user_name]:​v2</​nowiki>,​ and (if I've got the permissions right) there should be a "​Create this page" button.
  
 Good luck! Good luck!
  
 [[http://​abcnotation.com/​contact|Chris Walshaw]] (Editor) ​ [[http://​abcnotation.com/​contact|Chris Walshaw]] (Editor) ​
abc/standard/updating.txt · Last modified: 2014/07/12 08:03 by cwalshaw
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki