ArtefactConversion

From OOModels
Revision as of 12:50, 10 July 2008 by AndreasLeue (talk | contribs)
Jump to navigationJump to search

Artefact conversion is performed automatically by the DownloadManager when downloading an artefact. It is based on wiki pages describing what conversions are possible and pages that contain actual templates, stylesheets and alike.

See also DevelopmentPlan.

How to add a converter[edit]

Follow this simple procedure to add a conversion step:

  • Create a conversion step page in this package: Artefact:Step/org/oomodels/wiki/steps/conversion You can simply cut&paste an existing conversion step.
  • Edit the properties of that conversion step:
    • SourceType: the oomodels page describing the source format of your conversion
    • TargetType: the oomodels page describing the target format of your conversion
    • ConverterId: the oomodels page describing the converter used for the conversion. See Category:OOModels Format Converter.
    • Depending on the converter you choose:
      • XSLT Converter
        • Template: the oomodels page containing a XSL stylesheet
      • Identity Converter
        • no additional properties
      • OOGenerator Converter
        • Template: the oomodels page containing a OOGenerator template

If your conversion is based on an existing converter, you're done. Otherwise

  • add a Category:OOModels Format Converter page to describe the converter
  • add the converter software
    • to the wiki, by talking to us - either we review the software and incorporate into the oomodels download service, or, alternatively, we delegate conversion requests via SOAP to an online service you provide yourself (hint: we need contributors for oomodels anytime, e.g. someone adding the SOAP interface)
    • to the eclipse plugin, by just adding your software as a plugin and announcing it via an extension point