Documenting Standards

From openSUSE

Current revision

Basic guidelines

• Create the wiki page under Standards/
• If the standard is new, please document the use cases, requirements, constraints, etc.
• If the standard has its own existing specification, then link to it, document extensions.
• The added value of the openSUSE wiki is to help implement and enhance those specifications
• Provide examples. The grammar has the last word, but in order to implement it an example says much more
• If documenting XML based languages, use the already defined schema or dtd and extend it.
• If your XML grammar does not have any specification yet, please see XML standards
• If the standard is not yet used, and widely accepted by the community (it is still an idea) please mark the wiki page with the ProposedStandard template
• If the openSUSE version of the standard extends or modify the original, document it, and mark the modification with the NovellStandardExtension template

XML Standards

• When a spec is not available, document it using relaxng compact syntax
• You can use the trang program to convert back and forth DTDs and other XML schemas.