SVRL SQF/extension reference

QuickFixes in SVRL

Oxygen Content Model

Dynamic Content Model

Elements

<sqf:description>

Adds a human readable description to the parent element.

Parent elements
Child elements
Content model

Oxygen Content Model

Dynamic Content Model

Content model description

<sqf:fix>

Defines a QuickFix within a SVRL report.

Attributes
@base-uris

Description

Document URIs which are subject of the QuickFix. Multiple URIs are separated by whitespace.

Use

optional

Value

xs:string

@contextId

Description

The contextId attribute is an additional ID - unique for the context node which was selected for the <svrl:failed-assert>/<svrl:successful-report> element.

Use

required

Value

xs:string

@default

Use

optional

Value

xs:boolean

@fixId

Description

The fixId attribute contains the ID of the QuickFix from the Schematron schema. This ID offers the possibility to group the QuickFixes. For example, if the user decides to apply a QuickFix (from the Schematron schema) for a document in all cases, in this way the related QuickFixes can be determined in the SVRL.

Use

required

Value

xs:string

@id

Description

Is used for the unique identification of a QuickFix (ID). Each QuickFix within a SVRL report must have an unique ID.

The extractor uses this ID in order to activate the QuickFix.

The ID consists of the three other ID attributes (contextID, fixID and messageID) separated by dashes and becomes unique in this way.

Use

required

Value

xs:ID

@messageId

Description

The messageId attribute is unique for the appropriate <sch:assert> or <sch:report> element and is a supplement for the fixID. Since in the Schematron schema a QuickFix can be linked with different <sch:assert>/<sch:report> elements and double assigned fixID attributes may exist because of global and local QuickFixes, the grouping by means of the fixId attributes is in some cases not exactly enough. The combination of fixID and messageID may provide the user the possibility to concretise the relationship between the QuickFixes.

Use

required

Value

xs:string

@role

Description

Implementation for the role attribute of the SQF element <sqf:fix>.

Use

required

Value

  • replace

  • add

  • stringReplace

  • delete

  • mix

Content model

Oxygen Content Model

Dynamic Content Model

Content model fix

<sqf:param>

Determines for the parameter of a user entry the name (name), the ID (param-id), where applicable the type (as) and whether the user entry is obligatory (required). The content determines the default value of the user entry.

Parent elements
Attributes
@default

Description

This attribute defines a default value for a parameter or User Entry by using a XPath expression. If the attribute is set to a <sqf:param> element, the element must be empty.

Use

optional

Value

xs:string

Must be a valid XPath expression.

@name

Description

Indicates the name of the parameter as used in the Schematron QuickFix schema.

Use

required

Value

xs:string

@param-id

Description

Indicates an ID for the parameter. This ID is used as local name for the passing on of the parameter when calling the manipulator. The namespace of the parameter is the SQF namespace. Since the ID is unique within the SVRL report, parameter dublicates are prevented.

Use

required

Value

xs:ID

@required

Description

Indicates with yes whether an entry of the user in the user entry is required for the execution of the QuickFix.

Use

optional

Default

no

Value

  • yes

  • no

@type

Description

Indicates the determined type of the parameter. The value passed on must correspond to this type.

Use

optional

Value

xs:string

Content model

Oxygen Content Model

Dynamic Content Model

Content model param

<sqf:sheet>

Contains the QuickFix-specific XSLT elements of the manipulator.

Parent elements
Content model

Oxygen Content Model

Dynamic Content Model

Content model sheet

<sqf:title>

Parent elements
Content model

Oxygen Content Model

Dynamic Content Model

Content model title

<sqf:topLevel>

Contains the stylesheet framework of the manipulator.

Parent elements
Child elements
Attributes
@instance

Description

Indicates the absolute path of the validated instance.

Use

required

Value

xs:anyURI

@schema

Description

Indicates the absolute path of the Schematron schema used.

Use

required

Value

xs:anyURI

Content model

Oxygen Content Model

Dynamic Content Model

Content model topLevel

<sqf:user-entry>

Defines an user entry. With the help of the user entry, the user can interact with the QuickFix. The user entry contains a <sqf:param> element. The value of the parameter is set manually by the user. The implementation should provide the user entry when the user selects the QuickFix.

Parent elements
Content model

Oxygen Content Model

Dynamic Content Model

Content model user-entry

Attributes

@default-fix

Description

Determines the default QuickFix for a <svrl:failed-assert>/<svrl:successful-report> element.

Used by

Value

xs:IDREF

Must reference with the value to an ID of a QuickFix of the <svrl:failed-assert>/<svrl:successful-report> element.

Escali SVRL extensions

Oxygen Content Model

Dynamic Content Model

Elements

<es:dir>

Implementation for the inline Schematron element <sch:dir>.

Parent elements
Child elements
Attributes
@value

Description

One-to-one implementation of the same-named Schematron attribute.

Use

optional

Value

  • ltr

  • rtl

Content model

Oxygen Content Model

Dynamic Content Model

Content model dir

<es:emph>

Implementation for the inline Schematron element <sch:emph>.

Parent elements
Child elements
Content model

Oxygen Content Model

Dynamic Content Model

Content model emph

<es:span>

Implementation for the inline Schematron element <sch:span>.

Parent elements
Child elements
Attributes
@class

Description

One-to-one implementation of the same-named Schematron attribute.

Use

required

Value

xs:string

Content model

Oxygen Content Model

Dynamic Content Model

Content model span

Element groups

es:inline

Group of the inline elements which can be used for human readable text.

Content model

Oxygen Content Model

Dynamic Content Model

Content model inline

Attributes

@id

Description

ID for the determination of the origin of a SVRL element.

Used by

Use

required

Value

xs:string

A value being unique for the appropriate Schematron element.

@is-a

Description

Pattern ID of the abstract pattern called up.

Used by

Value

xs:string

@phases

Used by

Value

xs:string

@ref

Description

Reference of a paragraph to a <svrl:active-pattern> or <svrl:fired-rule> element.

Used by

Use

optional

Value

xs:string

The value must correspond to the value of the es:id attribute of a <svrl:active-pattern> or <svrl:fired-rule> element.

@regex

Used by

Value

xs:string

@roleLabel

Used by

Value

xs:string

@substring

Used by

Value

    Attribute groups

    schema.instance

    Attributes
    @instance

    Use

    optional

    Value

    xs:anyURI

    @schema

    Use

    optional

    Value

    xs:anyURI

    Content model

    Oxygen Content Model

    Dynamic Content Model

    Content model schema.instance

    © Copyright 2014-2017 Nico Kutscherauer

    ImprintContactSitemap