Difference between revisions of "Method description HTML file"

Latest revision as of 10:51, 28 May 2013

Method description HTML file is the HTML describing the method. This file must be located in the same plugin as the analysis itself. When you register your analysis method in extension point, you have to specify path to this file in "description" attribute.

Method description HTML file is used in several places:

• To display the method description in the information box in BioUML workbench or BioUML web edition;
• To generate the corresponding wiki page automatically (these pages appear in Analyses category).

When writing this HTML file, please follow the rules:

• Use the following formatting tags:
  • B, STRONG for bold text
  • I, EM for italic text
  • H1, H2, H3 for headlines
  • SUB for _subscripts
  • SUP for ^superscripts
  • CODE and TT for monospace text
  • PRE for preformatted text
  • A for external and mailto links
  • P for paragraphs
  • UL, OL, LI for lists
  • DL, DT, DD for definition lists
  • TABLE, TR, TD, TH for simple tables
  • BR for line breaks
• You can insert images using IMG tag. Image files should be located in the same directory as HTML itself.
• For formula blocks use <DIV CLASS="formula-text">
• Other HTML tags and custom CSS and attributes may not be converted correctly into Wiki markup.

In addition you can use the following macro substitutions:

%parameters%

will expand to automatically generated parameters description.

%analysisName%

will expand to the name of the current analysis.

%analysis:<analysis name>%

in BioUML workbench will expand to analysis name. In BioUML web edition and wiki will expand to the link to given analysis.