Colon missing from NOTE when rendered as HTML

[ghobona]

The generated HTML documents do not include colons when rendering notes. See attached screenshot.

This confuses readers. The word "NOTE" should immediately be followed by a colon ":" .

[opoudjis]

@Intelligent2013 I'm going to do this right after release, adding : to all /note/name in Presentation XML. I'll need you to confirm that you are taking : off, if you're adding it.

I'm assuming in all of this that we universally put space or tab between /{block}/name and /{block}/{text}, and that punctuation like : needs to get inserted at the end of /{block}/name .

[ronaldtse]

@opoudjis this seems to be a purely HTML output presentation issue. I don’t understand why the Presentation XML is affected.

[Intelligent2013]

Currently, XSLT puts these characters after note/name:

• BIPM: 'space'
• IEEE: '—' (em dash, 2014hex)
• GB, IHO, M3AAWG, OGC, UNECE, Ribose: ':'
• ITU, NIST: ' – ' (en dash with spaces around, 2013hex)

I'm going to do this right after release, adding : to all /note/name in Presentation XML. I'll need you to confirm that you are taking : off, if you're adding it.

@opoudjis would you like to put : for OGC only, or update Presentation XML for all flavors?

[opoudjis]

@ronaldtse This is why; we've allowed Pdf and Html to diverge, and they should not.

Yes, @Intelligent2013 , I'd like the delimiter to be in the Presentation XML.

[ronaldtse]

@ronaldtse This is why; we've allowed Pdf and Html to diverge, and they should not.

Completely disagree. PDF and HTML are different types of media.

[opoudjis]

After a lot of debate, we'll realise the delimiters between labels and contents as XSLT stylesheets that will be included in the Presentation XML header, and that can be specific to an output type.

This needs to be extended to the delimiters between biblio-tag and reference that are currently included within biblio-tag.

So labels (/name, /biblio-tag) are considered Presentation XML content, but delimiters between them and following content are considered Presentation XML styling ,and shall be kept separate from Presentation XML content.

[opoudjis]

This is going to be the initial test case for this mode of Presentation XML.

I'm going to also be migrating rendering-specific content from /misc-container to /render

/render will have children /render/preprocess-xslt, which will contain raw XSLT to be applied to the current document. /preprocess-xslt will have a comma-delimited "format" attribute; if it is not set, it is applied to all formats, and if it is set, it is applied to the given format, with legal values (for now) html, doc, pdf.

So this issue will be resolved with the following, and because it does not have @format, you and I both apply it:

<render>
  <preprocess-xslt>
    <xsl:template match="xmlns:note/xmlns:name">
    ....

which is equivalent to your

<xsl:template match="*[local-name() = 'note']/*[local-name() = 'name']">

I see you have a generic and parameterised piece of XSLT that does this already:

<xsl:template match="*[local-name() = 'note']/*[local-name() = 'name']">
		<xsl:param name="sfx"/>
		<xsl:variable name="suffix">
			<xsl:choose>
				<xsl:when test="$sfx != ''">
					<xsl:value-of select="$sfx"/>
				</xsl:when>
				<xsl:otherwise>

						<xsl:text>:</xsl:text>

				</xsl:otherwise>
			</xsl:choose>
		</xsl:variable>
		<xsl:if test="normalize-space() != ''">
			<xsl:apply-templates/>
			<xsl:value-of select="$suffix"/>
		</xsl:if>
	</xsl:template>

In the case of OGC, you don't include a sfx parameter, so NOTE as ":" appended. In ITU, you have <xsl:text>–</xsl:text>.

So what I am doing is grabbing that piece of XSLT, and applying it preemptively to my output, and also asking you to apply it to yours.

My question now is, are there any circumstances when you are populating that sfx parameter, that I need to be aware of?

[opoudjis]

I will need to add

<xsl:template match="node() | @*">
    <xsl:copy>
        <xsl:apply-templates select="node() | @*"/>
    </xsl:copy>
</xsl:template>

to my XSLT run, so that the Presentation XML passes through. I am leaving it out of the Presentation XML inclusion, so you pick only the rendering rules as a priority.

[opoudjis]

a.presentation 2.xml.zip

@Intelligent2013 This is the trial version including XSLT preprocessing. Please confirm that you can use it.

[opoudjis]

@ronaldtse

Extending this "refactoring" to the whole of Metanorma is a big task, and one I encourage you to delegate the task to another developer.

[Intelligent2013]

a.presentation 2.xml.zip

@Intelligent2013 This is the trial version including XSLT preprocessing. Please confirm that you can use it.

@opoudjis Confirm, I can use it.

[Intelligent2013]

My question now is, are there any circumstances when you are populating that sfx parameter, that I need to be aware of?

@opoudjis no, the sfx parameter isn't using anywhere. At one time I did refactoring and this parameter is out of date.

[opoudjis]

OK

I am going to close this ticket once you have confirmed this as done, @Intelligent2013. I am writing a separate ticket to roll this out across all flavours and all block types, but it will have to wait, since it will take a long time to implement, and I have more urgent tasks.