Package uk.ac.starlink.ttools.build
Class ShapeModeDoc
java.lang.Object
uk.ac.starlink.ttools.build.ShapeModeDoc
Writes XML text documenting known plot2 ShapeModes (shading modes).
Output is to standard output.
This class is designed to be used from its
main
method.- Since:
- 15 Sep 2014
- Author:
- Mark Taylor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a map (keyed by name) of all the ShapeModes known to Stilts.Returns XML element giving full user documentation for a given shading mode.static void
Main method.
-
Constructor Details
-
ShapeModeDoc
public ShapeModeDoc(boolean basicXml) Constructor.- Parameters:
basicXml
- avoid XML constructs that won't show up in text output
-
-
Method Details
-
getXmlDoc
Returns XML element giving full user documentation for a given shading mode.- Parameters:
mode
- shapemode- Returns:
- text of a <subsect> element
-
getShapeModes
Returns a map (keyed by name) of all the ShapeModes known to Stilts.- Returns:
- name->mode map
- Throws:
uk.ac.starlink.util.LoadException
-
main
Main method. Try-help
.- Throws:
uk.ac.starlink.util.LoadException
-