Difference between revisions of "Documentation/WADL conventions"
(→WADL markup conventions) |
(→WADL markup conventions) |
||
| Line 5: | Line 5: | ||
== What is WADL? == | == What is WADL? == | ||
| − | + | For information about WADL files, see http://docs.rackspace.com/writers-guide/content/ch_wadl.html. | |
| − | |||
| − | |||
| − | |||
| + | For complete information about the WADL language, see [http://www.w3.org/Submission/wadl/ Web Application Description Language] (http://www.w3.org/Submission/wadl/). | ||
| − | For | + | == Writing style == |
| + | |||
| + | For list methods, use the text: "Lists available xxx." Do not use "Gets a listing," or "Prints a listing." | ||
| + | For show (or get) methods, use the text: "Shows xxx details." Do not use, "Retrieves information about," or "Gets information for." | ||
== Markup == | == Markup == | ||
Revision as of 21:23, 20 February 2014
WADL markup conventions
What is WADL?
For information about WADL files, see http://docs.rackspace.com/writers-guide/content/ch_wadl.html.
For complete information about the WADL language, see Web Application Description Language (http://www.w3.org/Submission/wadl/).
Writing style
For list methods, use the text: "Lists available xxx." Do not use "Gets a listing," or "Prints a listing." For show (or get) methods, use the text: "Shows xxx details." Do not use, "Retrieves information about," or "Gets information for."
Markup
For list methods, use the text: "Lists available xxx." Do not use "Gets a listing," or "Prints a listing." For show (or get) methods, use the text: "Shows xxx details." Do not use, "Retrieves information about," or "Gets information for."
