Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README creation improvements ala TEI ticket 2070 #638

Merged
merged 5 commits into from
Nov 9, 2023
Merged

README creation improvements ala TEI ticket 2070 #638

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4224dd0
Tweak README builder for TEI ticket 2070
sydb Oct 23, 2023
739d94b
tweak a comment
sydb Oct 27, 2023
d4b77e3
Simplify patching version number.
sydb Oct 29, 2023
48d7406
merge in lastest from dev
sydb Nov 4, 2023
321de3e
latest from dev
sydb Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions profiles/readme/html/to.xsl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:tei="http://www.tei-c.org/ns/1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
exclude-result-prefixes="#all"
version="2.0">
<!-- import base conversion style -->
Expand Down Expand Up @@ -60,36 +61,54 @@ of this software, even if advised of the possibility of such damage.</p>
.../release/tei-p5-doc/share/doc/tei-p5-doc/
-->
<xsl:variable name="filename" select="tokenize( base-uri(/),'/')[last()]"/>
<xsl:param name="version" select="replace( $filename, '^readme-([0-9aαbβ.-]+)\.xml$','$1')"/>
<xsl:param name="version_from_filename" select="replace( $filename, '^readme-([0-9aαbβ.-]+)\.xml$','$1')"/>
<xsl:param name="vault" select="'https://www.tei-c.org/Vault/P5'"/>
<xsl:param name="docPath" select="'doc/tei-p5-doc/en/html'"/>

<!--
The version # we grabbed from the filename might not have the patch level ".0" at the end.
But the Guidelines we are trying to point to always have it. So here if we find only major-
dot-minor (rather than major-dot-minor-dot-patch), we append a ".0".
-->
<xsl:variable name="version" as="xs:string"
select="replace( $version_from_filename, '^([0-9]+\.[0-9]+)([aαbβ]?)$', '$1.0$2')"/>
<!-- $versionZero is true() iff the major number is '0'. -->
<xsl:variable name="versionZero" select="substring-before( $version, '.') eq '0'" as="xs:boolean"/>
<xsl:variable name="testVersionedDocument" select="concat( $vault,'/',$version,'/VERSION')"/>
<xsl:variable name="tagdocStart" select="concat( $vault,'/',$version,'/',$docPath,'/ref-')"/>

<xsl:template match="tei:gi|tei:ident[@type eq 'class']">
<xsl:template match="tei:gi | tei:name[ @type eq 'class']">
<xsl:variable name="class" select="if (@type) then @type else local-name(.)"/>
<!-- If this is the first one, check veresion number and warn iff needed -->
<xsl:if test="not( preceding::tei:gi | preceding::tei:ident[@type eq 'class'] )">
<xsl:if test="not( preceding::tei:gi | preceding::tei:name[ @type eq 'class'] )">
<xsl:choose>
<xsl:when test="$version eq ''">
<xsl:message>WARNING: unable to parse version # from filename, so links will not work</xsl:message>
</xsl:when>
<xsl:when test="not( doc-available( $testVersionedDocument ) )">
<xsl:message>WARNING: file <xsl:value-of select="$testVersionedDocument"/> cannot be read, so links will probably be broken</xsl:message>
<xsl:message>INFO: file <xsl:value-of select="$testVersionedDocument"/> could not be read</xsl:message>
</xsl:when>
<xsl:when test="normalize-space( unparsed-text( $testVersionedDocument ) ) ne normalize-space( $version )">
<xsl:message>WARNING: supplied version (<xsl:value-of select="$version"/>) is not equal to content of <xsl:value-of select="$testVersionedDocument"/>.</xsl:message>
</xsl:when>
<xsl:when test="substring-before( $version, '.') eq '0'">
<xsl:message>INFO: version number is &lt; 1.0.0, so not generating links for element &amp; class names.</xsl:message>
</xsl:when>
</xsl:choose>
</xsl:if>
<xsl:choose>
<xsl:when test="@scheme = ('TEI','tei') or not(@scheme)">
<!-- if this is prior to release 1.0.0, do not even bother trying to generate a link, just highlight it … -->
<xsl:when test="$versionZero">
<span class="{$class}"><xsl:apply-templates/></span>
</xsl:when>
<!-- else if it is a TEI element or class, make it into a link … -->
<xsl:when test="@scheme = ('TEI','tei') or not( @scheme )">
<xsl:variable name="content" select="normalize-space(.)"/>
<xsl:variable name="tagdoc" select="concat( $tagdocStart, $content, '.html' )"/>
<a class="{$class}" href="{$tagdoc}"><xsl:apply-templates/></a>
</xsl:when>
<!-- else this is not a TEI scheme element or name, also no link, just highlight it -->
<xsl:otherwise>
<!-- This is not a TEI scheme element or identifier -->
<span class="{$class}"><xsl:apply-templates/></span>
</xsl:otherwise>
</xsl:choose>
Expand Down