Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Tigerstripe XML Export Generation"
(New page: =XML Export Generator= This version of the Export Plugin can export a Tigerstripe Project: (i) as a single XML file (ii) as one XML file per artifact (with an additional file giving summ...) |
(→XML Export Generator) |
||
| Line 1: | Line 1: | ||
=XML Export Generator= | =XML Export Generator= | ||
| − | This version of the Export | + | This version of the XML Export Generator can export a Tigerstripe Project: |
(i) as a single XML file | (i) as a single XML file | ||
(ii) as one XML file per artifact (with an additional file giving summary details of the export). | (ii) as one XML file per artifact (with an additional file giving summary details of the export). | ||
| − | This behavior is controlled by the Global Property "singleFile". Set to TRUE, the export will be to a single file. | + | This behavior is controlled by the Global Property "singleFile". Set to TRUE, the default value, the export will be to a single file. |
Single File Export: | Single File Export: | ||
| Line 12: | Line 12: | ||
Where: | Where: | ||
| − | <xmldir> is a | + | <xmldir> is a user configured Global Property. The default value is "xml". |
<project_name> is the name of the Tigerstripe Project from which the export was generated. | <project_name> is the name of the Tigerstripe Project from which the export was generated. | ||
| − | The export file is generated according to the schema | + | The export file is generated according to the schema tigerstripeExportSchema.xsd, which has a namespace of “http://org.eclipse.tigerstripe/xml/tigerstripeExport/v1-0” and is also found in the "resources" directory of the Generator. During generation the schema file is copied to the same directory as the export XML file. |
File Per Artifact Export: | File Per Artifact Export: | ||
| − | With “singleFile” set to FALSE the | + | With “singleFile” set to FALSE the Generator exports the details of each artifact of the selected project to an individual XML file with the following default location and name: tigerstripe.gen\<xmldir>\<packageLocation>\<artifact_name>.xml |
where: | where: | ||
<xmldir> is as above. | <xmldir> is as above. | ||
| + | <packageLocation> is a folder structure that follows the package structure in the model, e.g. so for example for an artifact with the qualified name com.mycompany.model.ClassName the value of packageLocation will be com\mycompany\model. | ||
<artifact_name> is the name of the artifact. | <artifact_name> is the name of the artifact. | ||
| − | The export files are generated according to the schema | + | The export files are generated according to the schema tigerstripeArtifactExport.xsd, which has a namespace: of “http://org.eclipse.tigerstripe/xml/tigerstripeArtifactExport/v1-0” and is also found in the "resources" directory of the Generator and during generation is copied to the same directory as above. Note that this schema extends the tigerstripeExportSchema.xsd. |
| − | The plugin also | + | The plugin also generates a file giving a summary of the exported data. This file has the following default location and name: tigerstripe.gen\<xmldir>\<project_name>.xml. |
Where: | Where: | ||
<xmldir> and <project_name> are as described above. | <xmldir> and <project_name> are as described above. | ||
| − | The “summary” file is generated according to | + | The “summary” file is generated according to tigerstripeExportSchema.xsd. |
XSLT | XSLT | ||
| − | Through XSLT the export files generated in the “file per artifact” export can be converted to HTML to provide documentation of the Tigerstripe Project | + | Through XSLT the export files generated in the “file per artifact” export can be converted to HTML to provide documentation of the Tigerstripe Project. There is one XSL file for the “per artifact” export files and one for the “summary” export file. These can both be found in the "resources" directory of the Generator. During generation they are copied to the directory: tigerstripe.gen\<xmldir>\xsl in the model project target directory. |
| − | By default the | + | By default the Generator is provided with two simple XSL files. One XSL generating an index page from the “summary” export file, which links to artifact detail pages generated from the “per artifact” export files by the second XSL. The user can add their own XSL files and the plugin provides Global Properties to allow the user to override the XSL files referenced by the XML files: |
| − | < | + | <IndexXSL> sets the XSL file referenced in the “Summary” export file. |
| − | < | + | <ArtifactXSL> sets the XSL file referenced in each file generated through the “per artifact” export. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Revision as of 08:26, 21 May 2008
XML Export Generator
This version of the XML Export Generator can export a Tigerstripe Project: (i) as a single XML file (ii) as one XML file per artifact (with an additional file giving summary details of the export).
This behavior is controlled by the Global Property "singleFile". Set to TRUE, the default value, the export will be to a single file.
Single File Export:
The plugin exports all artifacts of the selected project in a single XML file with the following default location and name: tigerstripe.gen\<xmldir>\<project_name>.xml
Where: <xmldir> is a user configured Global Property. The default value is "xml". <project_name> is the name of the Tigerstripe Project from which the export was generated.
The export file is generated according to the schema tigerstripeExportSchema.xsd, which has a namespace of “http://org.eclipse.tigerstripe/xml/tigerstripeExport/v1-0” and is also found in the "resources" directory of the Generator. During generation the schema file is copied to the same directory as the export XML file.
File Per Artifact Export:
With “singleFile” set to FALSE the Generator exports the details of each artifact of the selected project to an individual XML file with the following default location and name: tigerstripe.gen\<xmldir>\<packageLocation>\<artifact_name>.xml
where: <xmldir> is as above. <packageLocation> is a folder structure that follows the package structure in the model, e.g. so for example for an artifact with the qualified name com.mycompany.model.ClassName the value of packageLocation will be com\mycompany\model. <artifact_name> is the name of the artifact.
The export files are generated according to the schema tigerstripeArtifactExport.xsd, which has a namespace: of “http://org.eclipse.tigerstripe/xml/tigerstripeArtifactExport/v1-0” and is also found in the "resources" directory of the Generator and during generation is copied to the same directory as above. Note that this schema extends the tigerstripeExportSchema.xsd.
The plugin also generates a file giving a summary of the exported data. This file has the following default location and name: tigerstripe.gen\<xmldir>\<project_name>.xml.
Where: <xmldir> and <project_name> are as described above.
The “summary” file is generated according to tigerstripeExportSchema.xsd.
XSLT
Through XSLT the export files generated in the “file per artifact” export can be converted to HTML to provide documentation of the Tigerstripe Project. There is one XSL file for the “per artifact” export files and one for the “summary” export file. These can both be found in the "resources" directory of the Generator. During generation they are copied to the directory: tigerstripe.gen\<xmldir>\xsl in the model project target directory.
By default the Generator is provided with two simple XSL files. One XSL generating an index page from the “summary” export file, which links to artifact detail pages generated from the “per artifact” export files by the second XSL. The user can add their own XSL files and the plugin provides Global Properties to allow the user to override the XSL files referenced by the XML files:
<IndexXSL> sets the XSL file referenced in the “Summary” export file. <ArtifactXSL> sets the XSL file referenced in each file generated through the “per artifact” export.