Help:- Template XML editingindexpreviousnextupside index
Template XML editing

Having created the template structure, the next stage is to provide some documentation about the Template.

The file:
plcslib\data\contexts\<<context-name>>\templates\<<template-id>>\template.xml
contains all the information about the template that is to be displayed in the built PLCSlib documentation.

This file should be edited, preferably in an XML Editor (see PLCSlib development Tools : XML Editor). The default file created by the template creation script contains numerous comments that are designed to aid the user in creating the documentation.

The Template XML File will be developed in parallel with the SysML defintion of the Template, hence this section only defines the initial editing that can be done prior to the creation of the SysML. (See Step 5)

Some of the information about the template has already been filled in by the creation script.

Two sections that should be filled in at this point of the process are :

The <contacts> section, at least with the reference to the editor

NOTE    The "ref" attribute is populated with the "id" of the referenced person as denoted in the contacts file for PLCSLib. This file can be found at plcslib\data\basic\contacts.xml

The <description> section, which should contain any relevant information about the template and what it is intended to support.

NOTE    All supporting images that are created as part of the documentation should be stored in the images folder of the Template and all files that are used as part of the development of the Template, such those created by SysML tools. should be stored in the dvlp folder of the Template. The exception to this are the diagrams generated by the SysML creation, which are stored directly in the Template folder.
Issue reporting