OSP Preconference Workshop:OSP Form Schemas and Renderers

Janice Smith, Education Consultant, Three CanoesSean Keesler, Education Consultant, Three Canoes

10th Sakai Conference - Boston, MA, U.S.A. 2

Objectives

• Understand the XML technology stack (XML, XSD, XSL)

• Understand the role of XSD and XSL in OSP forms• Understand how to manipulate form schema in

an XML IDE• Be able to capture the stored XML from an OSP

form• Be able to change a form’s appearance through

form schema and XSL renderers

July 2009

Form Design and Use

10th Sakai Conference - Boston, MA, U.S.A. 4

THE XML TECHNOLOGY STACKA little background…

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 5

XML

• A “Correct” XML document is a text file that is:• Well formed • Opening and closing tags that do not overlap

• Optionally validated against a set of rules• DTD and XML Schema

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 6

Parts of a Form XML document

• File MetaData • File ID and Display Name• Created and modified dates

• Structured Data• The form data for each field

• Schema information• Instructions and validation rules

• CSS information for stylingJuly 2009

10th Sakai Conference - Boston, MA, U.S.A. 7

Explore Form XML in Oxygen IDE

• You do it!• Open “sampleFormXML.xml”• Identify the parts of the XML document• Identify what fields were filled out• Identify the form instructions when this form

was completed• Use OxygenXML to identify the set of

elements in the XML to get the “displayName” of this file

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 8

XPATH

• Expressions that are used by many technologies (including XSLT) to specify one or more parts of an XML document (a node set) that meet a set of conditions

• Can be an absolute path:• /formView/formData/artifact/metaData/

repositoryNode/created

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 9

XPATH

July 2009

Can be an absolute path:/formView/formData/artifact/metaData/repositoryNode/created

… refers to:“<created>Thu Jul 02 17:03:00 UTC 2009</created>”

10th Sakai Conference - Boston, MA, U.S.A. 10

XPATH

• Can be a relative PATH:../../displayName

July 2009

…refers to “<displayName>Test Feedback</displayName>”

if used from the “created” element

10th Sakai Conference - Boston, MA, U.S.A. 11

XPATH

• Can include conditions in “predicates”//element[@name=‘value’]/

• …refers to all “element” node sets that have their “name” attribute set to “value”

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 12

Finding an XPATH with OxygenXML

July 2009

XPATH expressions can be generated and tested by using the XPATH functionality in Oxygen

10th Sakai Conference - Boston, MA, U.S.A. 13

XPATH

• You do it!• Find the XPATH to the <displayName>

element of the formView XML• Generate an XPATH expression that will refer

to the “value” field in the form’s structured data• Generate an XPATH expression that will refer

to the last date the form data was modified

July 2009

14

What is an XML Schema?

• An XML document• Describes other XML data files• Structure• Data types• Data validation rules

• Provides a means to “validate” another XML document

10th Sakai Conference - Boston, MA, U.S.A. 15

XSD Example

Form requirements:3 fields• Evaluation – Numeric value from 0 – 3• “Short” Rich text field – 1200 characters

max• Rich text field – “no limit”

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 16

XSD Example

• One way to represent the “Value” field <xs:element name="value"> <xs:simpleType> <xs:restriction base="xs:integer"> <xs:minInclusive value="0"/> <xs:maxInclusive value="3”/> </xs:restriction> </xs:simpleType> </xs:element>

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 17

XSD in OSP

• XSD describes “valid” dataAND

• Provides information to form presentation tool about how to render the HTML form

• Uses “ospi” extensions• Form field labels and descriptive text • Use of rich text editor• “Subform keys”

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 18

XSD in OSP Examples

This XSD snippet:<xs:element name="value" minOccurs="0">

<xs:annotation> <xs:documentation source="ospi.label">Evaluation </xs:documentation>

</xs:annotation><xs:simpleType>

<xs:restriction base="xs:string"><xs:enumeration value="3"></xs:enumeration><xs:enumeration value="2"></xs:enumeration><xs:enumeration value="1"></xs:enumeration><xs:enumeration value="0"></xs:enumeration>

</xs:restriction>

</xs:simpleType>

</xs:element>

July 2009

Produces this HTML form field:

10th Sakai Conference - Boston, MA, U.S.A. 19

Explore XSD in OSP

• You do it!• Open “schemaEnumeratedTextValue.xsd”• Identify the form elements and validation rules• Change the “value” scale to include 5 values• Reorder the fields so that the “value” field is last on the

form• Make the “value” a required field• Add a new field that prompts user for an evaluation

date of the type “xs:date”• Create a new form with this new schema and see the

results by “Previewing” the form.July 2009

10th Sakai Conference - Boston, MA, U.S.A. 20

Questions about:XMLXSD

XPATH

July 2009

FORM RENDERING LOGIC

An XSL Primer

• An XML document can be “transformed” into a new XML document by a set of instructions written in XSLT (Extensible Stylesheet Language Transformation)

• Sakai includes XalanJ - an XSLT processor

23

A “passthrough” XSL file

• Instructs the XSL processor to send a copy of the input as its output.

• Useful because we have no way to see the raw XML “behind the scenes” that we want to transform.

• Included in handouts as “passthrough.xsl”

10th Sakai Conference - Boston, MA, U.S.A. 24

Passthrough XSL

• Note the use of the XPATH expression in the match attribute

• Specifies we are taking a “copy-of” everything below the “root element”

July 2009

Form Rendering XSL

• When Sakai renders a form, it assembles an XML document behind the scenes.

• Form XML is rendered using the default renderers (formCreate.xslt/formFieldTemplate.xslt) or your custom renderers.

• Use a “passthrough” xsl as a custom renderer to capture the raw form XML

• Use that as your XML input in an XML IDE to create your own form renderers.

26

Capture “Raw” form XML

• You do it!• Create a form using the the “practice” schema in your

handouts. Upload the passthrough XSL file to resources and use it as a form view renderer for this form.

• Fill the form out in resources.• Click on the form name in resources• Capture the form XML (you need to “view source” since it

isn’t HTML).• Copy and paste it into a new XML document in Oxygen• Use Oxygen “Format and Indent” ( ) feature to format

the file.• Save the file as “formPassthrough.xml”

27

“Import” Rather than “Include”

• The default formCreate.xslt renderer “includes” the formFieldTemplate stylesheet.

• If you want fields to be rendered differently than the defaults, import formFieldTemplate.xslt and override form field templates locally.

• Use “customFormCreate.xslt” from the handouts

28

Oxygen and XSL

• Oxygen is shipped with XalanJ• “Transformation Scenarios” can be

established to transform one XML document with an XSL stylesheet

• Allows for quicker iterative development than repeatedly uploading your XSL stylesheets into Sakai

10th Sakai Conference - Boston, MA, U.S.A. 29

Configure Transformation Scenario• Start with the document

you wish to transform• Establish a new project

scenario• Inputs

• XML URL: ${currentFileURL} (the default)

• XSL URL: browse to locate your new stylesheet

• Transformer: Xalan• Extensions: add the xslt-

façade.jar (in handouts)July 2009

10th Sakai Conference - Boston, MA, U.S.A. 30

Configure a Transformation Scenario

• Outputs:• Save As: “out.html”• “Open in Browser”

and “Saved File”: if you want to view it in a browser

• “Open in Editor” to view the XML output

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 31

Create a Custom Form Renderer

• Watch me! • Using the “practice” form from earlier• Set up a scenario with the raw XML and the

“formCustomCreate.xslt” in the handouts• Add a prompt for the “shortText” field and view

the results of a transformation.• Switch the “import” of the formFieldTemplate to

import from Sakai rather than your desktop.• Upload the file and attach it as your custom

renderer for this form.July 2009

10th Sakai Conference - Boston, MA, U.S.A. 32

Create a Custom Form Renderer

• You do it! • Using the “practice” form from earlier• Set up a scenario with the raw XML and the

“formCustomCreate.xslt” in the handouts• Add prompts for the “description” and “value” fields

only and view the results of a transformation• Change their order and transform it.• Add descriptive text somewhere on the form about the

meaning of each “value” and transform it.• Upload the new renderer and attach it as your custom

renderer for this form.July 2009

10th Sakai Conference - Boston, MA, U.S.A. 33

Other Ideas for Renderers

• Adding your own CSS files to change the look of a form

• Attachment of custom JavaScript files to change the form behavior

• Addition of “default” text to form fields• Others?

July 2009

10th Sakai Conference - Boston, MA, U.S.A. 34

Questions about:OxygenXML

XSLForm rendering process

Form renderers

July 2009