Changes between Version 6 and Version 7 of TracXsdPlotMacro

Timestamp:

Jul 27, 2016, 8:35:31 AM (8 years ago)

Author:

Theodor Norup

Comment:

Update param descriptions to V1.1

TracXsdPlotMacro

@@ -11 +11 @@
 Output is as indicated in this example:
 
-[[Image(trac-hacks-example.png,width=300)]]
+[[Image(trac-hacks-example_1.1.png,width=300)]]
 
-=== Assumptions
-
-The current version assumes that an XSD file contains exactly one `ComplexType` definition at top level.
 
 == !Bugs/Feature Requests
@@ -76 +73 @@
 }}}
 
+== Possible trac links for input files/resources:
 
-The Location of the resource (first parameter) can be an attachment (to a wikipage, or a ticket) a file in svn or a local file (keyword "file:").
+||= Trac link =||= Alternatives =||= Comment              =||
+|| wiki:        ||  !JustPageName || Wiki page attachment ||
+|| ticket:      ||  !#1           || Ticket attachment    ||
+|| source:      ||  browser,repos || File stored in subversion ||
+|| file:        ||                || Local file. Path prefix read from `file.prepath` in trac.ini  ||
 
-||= '''Trac link''' =||= '''Alternatives''' =||= '''Comment''' =||
-|| `wiki`        ||  !JustPageName || Attachment in wikipage ||
-|| `ticket`      ||  !#1           ||                        ||
-|| `source`      ||  browser,repos ||                        ||
-|| `file`        ||                || remember configuration value `file.prepath`   ||
 
-''Parameters:''
+== XSD layout selectiveness control parameters:
+||= Parameter =||= Value                 =||= Default =||
+|| top-element || select specific top XSD element of plot || assumes file to contain '''exactly one''' XSD root element. Otherwise the first element encountered will be plotted. ||
+|| depth       || maximum depth counted in elements || infinity ||
+|| stop-list   || Pipe-separated list of XSD element names where recursive descent shall stop || empty ||
 
-||= '''Parameter''' =||= '''Value'''                 =||= '''Default''' =||                         ||
-|| `xsdfile`   || location of XSD file    ||           || required                ||
-|| `width`       || width in pixel          || 600       ||  must be absolute value ||
-|| `caption`     || caption under image     || ''none''  ||                         ||
-|| `label`       || anchor to link to       ||           ||                         ||
-|| `cache`       || build once or each time || True      ||  time consumption or changing vectorgraphics  ||
-|| `align`       || left|right              || nothing   ||                         ||
+
+== Other parameters:
+||= Parameter =||= Value                 =||= Default =||= Note =||
+|| img-type    || 'png' or 'svg'          || svg       || case INsensitive ||
+|| width       || width in pixel          || 600       || must be absolute value ||
+|| caption     || Caption under image     || ''none''  ||       ||
+|| label       || anchor to link to       ||           ||       ||
+|| cache       || build once or each time || True      || time consumption or changing vector graphics  ||
+|| align       || left|right              || nothing   ||       ||
+
 
 == Recent Changes