3.9 years ago by
United States
Hi,
General guidelines:
-
For tag pairs that are self-contained, please keep everything on the same line. Meaning, do not introduce new lines. Technically, new lines are just converted to spaces by the parser, but this is the formatting used for Galaxy tool dev.
-
Use indentation for nested tags, this helps with readability. Yes, the tags are split on different lines with these, but it serves a different "ease of readability" purpose, and is not just for aesthetics.
-
Try to use the format conventions already in use - this will help others when reading, potentially revising.
-
All other standard XML formatting rules apply, of course, but you probably knew that. A google will bring up specs if you need specific help.
To help more, I wanted to find you a few simple examples of existing tool's XML that you can use to model after. And please explore other tools in the distrubution or the Tool Shed (http://usegalaxy.org/toolshed) for even more.
Here is one that includes the wrapper name, tool version, and such - plus "help" on the tool form and a citation:
https://bitbucket.org/galaxy/galaxy-dist/src/a2308bdc93b897af974766b190abe019ade49e9a/tools/maf/interval2maf.xml?at=default
And this is a simple one that has comments included a the top:
https://bitbucket.org/galaxy/galaxy-dist/src/a2308bdc93b897af974766b190abe019ade49e9a/tools/data_source/biomart.xml?at=default
Hopefully this helps! If our dev team has more to add, they will post. Jen, Galaxy team
