Schema config.xsd


schema location:  D:\_eLML_25\core\structure\config.xsd
attribute form default:  unqualified
element form default:  qualified
targetNamespace:  http://www.elml.ch
 
Elements 
chapter_numeration 
config 
contact 
converter_pixel_mm 
course 
display_links 
documentclass 
fontsize 
fontweighttitle 
fop_version 
general 
hyphenation 
labelname 
latex 
lineheight 
manifest_type 
modules 
msg 
online 
optional_units 
pagebreak_level 
pageheight 
pagewidth 
print 
role 
server 
terms 


element chapter_numeration
diagram config_Reference_p1.png
type elml:YesNoType
used by
element general
facets
Kind Value annotation 
enumeration no 
enumeration yes 
annotation
documentation
The element chapter_numeration allow switching on ('yes') and off ('no') the numeration of the chapters, units, ... within a lesson or course.

element config
diagram config_Reference_p2.png
children elml:general elml:online elml:print elml:latex elml:modules elml:terms
annotation
documentation
The root element of the project specific config.xml file.
Important: All the elements within the config.xsd file are optional. If you don't use an element then a default value might be used (e.g. the Sourceforge bugtracker). If you use an element but leave it empty (e.g. an empty element bugtracker) then the element will not be used (e.g. no bugtracker link in the lesson). If you leave an element empty that is needed for the transformation then also the default value will be used.

element contact
diagram config_Reference_p3.png
type elml:EmailType
used by
element general
facets
Kind Value annotation 
pattern [^@]+@[^\.]+\..+ 
annotation
documentation
The element contact contains an contact email address that allows the students to contact the tutor of a lesson or course.

element converter_pixel_mm
diagram config_Reference_p4.png
used by
element print
annotation
documentation
The element converter_pixel_mm contains the conversion factor from pixel to mm. This value is set fix to '0.2646'.

element course
diagram config_Reference_p5.png
children elml:labelname
used by
element modules
attributes
Name  Type  Use  Default  Fixed  annotation
titlexs:stringoptional      
documentation
The attribute title allows specifying a specific title for the course. This title will be visible on the title page of the print (PDF) version but not in the online version.
subnavigationelml:YesNoTypeoptional  no    
documentation
The attribute subnavigation allows switching on ('yes') or off ('no', default value) that all the entries in the navigation are shown. 'no' shows only the navigation entries of the first lesson and the titles of the following lessons. Clicking one of those titles will open the navigation of that lesson and close the one of the first/open lesson.
authorsxs:stringoptional      
documentation
The element authors allows specifying all the authors that have created the lessons of a course. This information will be shown on the title page of the print (PDF) version but not in the online version. The authors information in the metadata is still visible.
annotation
documentation
The element course defines through its subelements labelname which lessons belong together in one course.

attribute course/@title
type xs:string
annotation
documentation
The attribute title allows specifying a specific title for the course. This title will be visible on the title page of the print (PDF) version but not in the online version.

attribute course/@subnavigation
type elml:YesNoType
facets
Kind Value annotation 
enumeration no 
enumeration yes 
annotation
documentation
The attribute subnavigation allows switching on ('yes') or off ('no', default value) that all the entries in the navigation are shown. 'no' shows only the navigation entries of the first lesson and the titles of the following lessons. Clicking one of those titles will open the navigation of that lesson and close the one of the first/open lesson.

attribute course/@authors
type xs:string
annotation
documentation
The element authors allows specifying all the authors that have created the lessons of a course. This information will be shown on the title page of the print (PDF) version but not in the online version. The authors information in the metadata is still visible.

element display_links
diagram config_Reference_p6.png
type elml:YesNoType
used by
element print
facets
Kind Value annotation 
enumeration no 
enumeration yes 
annotation
documentation
In the PDF version of a lesson or course the links are clickable. The element display_links allows defining if additionally the link URI shall be written in brackets after the link text (useful when the digital version is printed out an the links are no longer visible and useable): 'yes' writes the links URI in the PDF, 'no' does not.

element documentclass
diagram config_Reference_p7.png
type restriction of xs:string
used by
element latex
facets
Kind Value annotation 
enumeration article 
enumeration book 
annotation
documentation
The element documentclass allows defining the type of document created in latex. The values are 'article' (e.g. for a single lesson) or 'book' (e.g. for the transformation of a course consisting of several lessons).

element fontsize
diagram config_Reference_p8.png
type xs:string
used by
element print
annotation
documentation
The element fontsize allows defining your default font size, e.g. '11pt'.

element fontweighttitle
diagram config_Reference_p9.png
type xs:string
used by
element print
annotation
documentation
The element fontweighttitle allows defining your default font weight for titles, e.g. 'bold'.

element fop_version
diagram config_Reference_p10.png
type restriction of xs:decimal
used by
element print
facets
Kind Value annotation 
enumeration 0.2 
enumeration 0.9 
annotation
documentation
The element fop_version allows specifying the FOP version used for transformation. If you use the latest FOP version enter the value '0.9' otherwise use '0.2'.

element general
diagram config_Reference_p11.png
children elml:contact elml:server elml:role elml:pagebreak_level elml:chapter_numeration elml:manifest_type elml:optional_units
used by
element config
annotation
documentation
The element general contains general information needed for the transformation of a eLML lesson (not specific for an online or print version, are used in all versions).

element hyphenation
diagram config_Reference_p12.png
type elml:YesNoType
used by
element print
facets
Kind Value annotation 
enumeration no 
enumeration yes 
annotation
documentation
The element hyphenation activates hyphenation in the PDF (yes) or not (no).

element labelname
diagram config_Reference_p13.png
type elml:LabelType
used by
elements course optional_units
facets
Kind Value annotation 
pattern ([A-Za-z0-9_])* 
annotation
documentation
The element labelname contains the label of an existing lesson (for course definitions) or unit (for defining optional units).

element latex
diagram config_Reference_p14.png
children elml:documentclass
used by
element config
annotation
documentation
The element latex contains information specific to the transformation of an eLML lesson into latex (another print version).

element lineheight
diagram config_Reference_p15.png
type xs:string
used by
element print
annotation
documentation
The element lineheight allows defining your default line height, e.g. '15pt'. This value needs to be bigger than the fontsize value.

element manifest_type
diagram config_Reference_p16.png
type restriction of xs:string
used by
element general
facets
Kind Value annotation 
enumeration ims 
enumeration scorm 
enumeration both 
annotation
documentation
The element manifest_type allows defining which type of imsmanifest.xml file will be produced: IMS CP or SCORM compatible. Accepted values are 'ims', 'scorm' or 'both'.

element modules
diagram config_Reference_p17.png
children elml:course
used by
element config
annotation
documentation
The element modules contains information specific to the transformation of several eLML lessons into one course.

element msg
diagram config_Reference_p18.png
type extension of xs:string
used by
element terms
attributes
Name  Type  Use  Default  Fixed  annotation
namexs:string      
documentation
The attribute name defines the name of the title to be redefined.
langelml:LanguageTypeoptional      
documentation
The attribute lang allow defining the language of the redefined title.
annotation
documentation
The element msg redefines a preset title. The new title is written in plain text within the element msg.

attribute msg/@name
type xs:string
annotation
documentation
The attribute name defines the name of the title to be redefined.

attribute msg/@lang
type elml:LanguageType
facets
Kind Value annotation 
enumeration de 
enumeration fr 
enumeration it 
enumeration en 
annotation
documentation
The attribute lang allow defining the language of the redefined title.

element online
diagram config_Reference_p19.png
children elml:bugtracker elml:use_navigation elml:use_labelReferences elml:use_embed elml:html_version elml:css_framework elml:icon_filetype elml:lightwindow
used by
element config
annotation
documentation
The element online contains information specific to the transformation of an eLML lesson into html (an online version).

element online/bugtracker
diagram config_Reference_p20.png
type xs:anyURI
annotation
documentation
The element bugtracker contains the URL to your bugtracker form. Leave the element empty if you don't have a bugtracker.

element online/use_navigation
diagram config_Reference_p21.png
type elml:YesNoType
facets
Kind Value annotation 
enumeration no 
enumeration yes 
annotation
documentation
The element use_navigation allows switching on ('yes') or off ('no') the creation of a navigation in the transformation to an online version.

element online/use_labelReferences
diagram config_Reference_p22.png
type xs:string
annotation
documentation
The element use_labelReferences allows using the specific java script (or similar) files for referencing and/or highlighting specific parts of a lesson. Interpreted are the values 'no' (no highlighting), 'yes' (highlighting with a default colour) or a colour value such as #FEF456 or red (highlighting with the specified colour value).

element online/use_embed
diagram config_Reference_p23.png
type elml:YesNoType
facets
Kind Value annotation 
enumeration no 
enumeration yes 
annotation
documentation
The element use_embed allows specifying of the deprecated HTML 1.0 element 'embed' should be used for embedding multimedia objects in HTML pages. Set it to 'no' if you want to create XHTML 1.1 code (may need adjustements of your layout). Set it to 'yes' (default, used if you don't use this element in the config.xml file) if you don't care, if you want to use your old layouts, etc...

element online/html_version
diagram config_Reference_p24.png
type restriction of xs:string
facets
Kind Value annotation 
enumeration 1.0 
enumeration 1.1 
annotation
documentation
The element html_version allows specifying if XHTML 1.0 or XHTML 1.1 shall be created when transforming a lesson to HTML. Default is 1.0.

element online/css_framework
diagram config_Reference_p25.png
type restriction of xs:string
facets
Kind Value annotation 
enumeration none 
enumeration yaml 
annotation
documentation
The element css_framework allows defining a css framework to be used for the layout of the lesson transformed into html. At the moment the values 'none' and 'yaml' (see www.yaml.de for more information) are supported.

element online/icon_filetype
diagram config_Reference_p26.png
type restriction of xs:string
facets
Kind Value annotation 
enumeration gif 
enumeration png 
enumeration jpg 
annotation
documentation
The element css_framework allows defining a css framework to be used for the layout of the lesson transformed into html. At the moment the values 'none' and 'yaml' (see www.yaml.de for more information) are supported.

element online/lightwindow
diagram config_Reference_p27.png
type elml:YesNoType
facets
Kind Value annotation 
enumeration no 
enumeration yes 
annotation
documentation
The element lightwindow allows the use of Kevin Millers lightwindow-script (www.stickmanlabs.com). To use it create a multimedia element and add a thumbnail attribute. If you click on the thumbnail the large version opens full screen and the background dimms down.

element optional_units
diagram config_Reference_p28.png
children elml:labelname
used by
element general
annotation
documentation
The element optional_units allows defining the units that should be marked/highlighted as optional for the student. Insert for each optional unit a separate subelement labelname.

element pagebreak_level
diagram config_Reference_p29.png
type restriction of xs:string
used by
element general
facets
Kind Value annotation 
enumeration oneoutput 
enumeration lesson 
enumeration unit 
enumeration lo 
annotation
documentation
The element pagebreak_level allows defining on which levels page breaks in the html, pdf, ... version are generated. Possible values are 'oneoutput', 'lesson', 'unit' or 'lo'. For a single lesson the values 'oneoutput' and 'lesson' generate the same output. There is a difference between these two values when transforming several lessons to a course.

element pageheight
diagram config_Reference_p30.png
type xs:string
used by
element print
annotation
documentation
The element pageheight allows defining the height of your page, e.g. '29.7cm' for an A4 portrait format.

element pagewidth
diagram config_Reference_p31.png
type xs:string
used by
element print
annotation
documentation
The element pagewidth allows defining the width of your page, e.g. '21cm' for an A4 portrait format.

element print
diagram config_Reference_p32.png
children elml:display_links elml:hyphenation elml:fop_version elml:pageheight elml:pagewidth elml:fontsize elml:lineheight elml:fontweighttitle elml:converter_pixel_mm
used by
element config
annotation
documentation
The element print contains information specific to the transformation of an eLML lesson into pdf (a print version).

element role
diagram config_Reference_p33.png
type restriction of xs:string
used by
element general
facets
Kind Value annotation 
enumeration tutor 
enumeration student 
annotation
documentation
The element role defines if the transformation is to be made for a 'tutor' or a 'student' view of the content.

element server
diagram config_Reference_p34.png
type xs:anyURI
used by
element general
annotation
documentation
The element server contains the URL to the homepage of your server (e.g. http://www.gitta.info).

element terms
diagram config_Reference_p35.png
children elml:msg
used by
element config
annotation
documentation
The element terms allows redefining the preset names for the different titles within the lesson, such as bibliography or learning objectives. Use for each redefinition a new subelement msg.


XML Schema documentation generated by
XMLSpy Schema Editor http://www.altova.com/xmlspy