tr:patch-svrl patch-svrl

htmlreports/xpl/patch-svrl.xpl

Import URI: patch-svrl.xpl

This step patches error report(s) into an HTML document and provide an HTML report.

Output Ports

NameDocumentationConnections

result

The HTML report document containing the error messages.

secondary

messages-grouped-by-type.xml, linked-messages-grouped-by-srcpath.xml for further processing (e.g., list of all message types)

Options

NameDocumentationDefault

debug

'no'

debug-dir-uri

'debug'

status-dir-uri

'status'

max-errors-per-rule

'200'

severity-default-name

'no-role'

report-title

''

show-adjusted-srcpath

'yes'

show-step-name

'yes'

discard-epub-schematron-svrl

'no'

suppress-embedding

Space-separated list of tokens. Available tokens are: image video script style audio object #all.

The documentation in tr:html-embed-resources could be more up to date.

''

Subpipeline

StepInputsOutputsOptions

tr:simple-progress-msg start-msg

source

source params on patch-svrl

msgs

 <c:messages>
   <c:message xml:lang="en">Patching messages into HTML rendering</c:message>
   <c:message xml:lang="de">Montiere die Meldungen in das HTML-Rendering</c:message>
 </c:messages>

result

file = 'patch-svrl-start.txt'

status-dir-uri = $status-dir-uri

tr:html-embed-resources html-embed-resources-before-delete

source

source on patch-svrl

result

exclude = $suppress-embedding

fail-on-error = 'false'

debug = $debug

p:delete filter-document

Just in case that there are blank lines in front of the XHTML -- these will constitute an empty document by themselves. In addition, @xml:base attributes will give a funny link click experience.

source

result on html-embed-resources-before-delete

result

match = '@xml:base'

tr:store-debug d161e115

source

result on filter-document

result

pipeline-step = 'htmlreports/filtered'

active = $debug

base-uri = $debug-dir-uri

p:sink d161e121

source

result on d161e115

p:wrap-sequence reports

source

reports on patch-svrl

result

wrapper = 'c:reports'

p:xslt reorder-messages-by-category

This XSLT will regroup the messages using a span in the asserts/reports.

The span's class used to regroup can be defined as te content of param name 'rule-category-span-class' in the parameter set. (For example ina project specific transpect-conf.xml) The span's content will appear as a heading in the html report.

If it isn't defined or no such spans occur the reports document will be reproduced.

If not every assert/report has a span with that class the original rule-family is used.

source

result on reports

parameters

params on patch-svrl

stylesheet

p:document../xsl/regroup-messages-to-category.xsl

result

tr:store-debug d161e146

source

result on reorder-messages-by-category

result

pipeline-step = 'htmlreports/reports-regrouped'

active = $debug

base-uri = $debug-dir-uri

p:sink d161e152

source

result on d161e146

tr:load-cascaded load-template

paths

params on patch-svrl

result

filename = 'htmlreports/template/template.html'

fallback = resolve-uri('../template/template.html')

debug = $debug

debug-dir-uri = $debug-dir-uri

p:sink d161e166

source

result on load-template

tr:store-debug debug-load-template

source

result on load-template

result

pipeline-step = 'htmlreports/template-loaded'

extension = 'html'

active = $debug

base-uri = $debug-dir-uri

p:insert inject-body

source

result on debug-load-template

insertion

result on filter-document

result

match = '//html:div[@id eq 'tr-content']'

position = 'first-child'

p:insert create-element-for-orphaned-messages

source

result on inject-body

insertion

 <div id="BC_orphans"><p srcpath="BC_orphans"/><p srcpath=""/></div>

result

match = '//html:div[@id eq 'tr-content']'

position = 'first-child'

p:insert inject-head

source

result on create-element-for-orphaned-messages

insertion

result on filter-document

result

match = '/html:html/html:head'

position = 'first-child'

tr:store-debug d161e205

source

result on inject-head

result

pipeline-step = 'htmlreports/template-injected'

extension = 'html'

active = $debug

base-uri = $debug-dir-uri

tr:html-embed-resources html-embed-resources

source

result on d161e205

result

fail-on-error = 'false'

exclude = $suppress-embedding

debug = $debug

tr:store-debug d161e223

source

result on html-embed-resources

result

pipeline-step = 'htmlreports/template-with-data-uris'

extension = 'html'

active = $debug

base-uri = $debug-dir-uri

p:sink d161e229

source

result on d161e223

tr:store-debug d161e230

source

result on reports

result

pipeline-step = 'htmlreports/reports'

active = $debug

base-uri = $debug-dir-uri

p:sink d161e241

source

result on d161e230

tr:load-cascaded load-svrl2xsl

paths

params on patch-svrl

result

filename = 'htmlreports/svrl2xsl.xsl'

fallback = 'http://transpect.io/htmlreports/xsl/svrl2xsl.xsl'

debug = $debug

debug-dir-uri = $debug-dir-uri

p:sink d161e253

source

result on load-svrl2xsl

p:xslt create-patch-xsl

source

result on reorder-messages-by-category

result on html-embed-resources

stylesheet

result on load-svrl2xsl

parameters

params on patch-svrl

result

tr:store-debug d161e293

source

result on create-patch-xsl

result

pipeline-step = 'htmlreports/patch-svrl'

extension = 'xsl'

active = $debug

base-uri = $debug-dir-uri

p:sink d161e299

source

result on d161e293

p:for-each d161e300

secondary on create-patch-xsl

tr:store-debug d161e307

source

current on d161e300

result

pipeline-step = concat('htmlreports', replace(base-uri(), '^.+(/.+?).xml', '$1'))

active = $debug

base-uri = $debug-dir-uri

p:sink d161e316

source

result on d161e307

p:xslt create-fallback

source

result on html-embed-resources

stylesheet

result on create-patch-xsl

parameters

params on patch-svrl

result

initial-mode = 'create-fallback'

tr:store-debug d161e335

source

result on create-fallback

result

pipeline-step = 'htmlreports/1.create-fallback'

extension = 'xhtml'

active = $debug

base-uri = $debug-dir-uri

p:xslt patch

source

result on d161e335

stylesheet

result on create-patch-xsl

parameters

params on patch-svrl

result

tr:store-debug d161e353

source

result on patch

result

pipeline-step = 'htmlreports/2.patch-main'

extension = 'xhtml'

active = $debug

base-uri = $debug-dir-uri

p:xslt remove-fallback

source

result on d161e353

stylesheet

result on create-patch-xsl

parameters

params on patch-svrl

result

initial-mode = 'remove-fallback'

tr:store-debug d161e371

source

result on remove-fallback

result

pipeline-step = 'htmlreports/3.remove-fallback'

extension = 'xhtml'

active = $debug

base-uri = $debug-dir-uri

p:sink d161e377

source

result on d161e371

p:identity messages-grouped-by-type

source

secondary on create-patch-xsl

result

p:xslt create-success-messages

source

result on messages-grouped-by-type

stylesheet

p:document../xsl/create-success-messages.xsl

parameters

params on patch-svrl

result

tr:simple-progress-msg success-msg

source

result on create-success-messages

msgs

result on create-success-messages

result

file = 'patch-svrl-success.txt'

status-dir-uri = $status-dir-uri

p:sink d161e407

source

result on success-msg