Skip to content

astxml2markdown.xslt: Change processing of "note" and "warning" #66

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

Merged
gtjoseph merged 1 commit into from
Mar 13, 2024
Merged

astxml2markdown.xslt: Change processing of "note" and "warning" #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ mkdocs-material==9.5.6
mkdocs-material-extensions==1.3.1
mkdocs-minify-plugin==0.8.0
mkdocs-table-reader-plugin==2.1.0
lxml==4.9.3
lxml==5.1.0
pymdown-extensions==10.4
11 changes: 9 additions & 2 deletions utils/astxml2markdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,17 @@

class FormatExample(etree.XSLTExtension):
def __init__(self):
self.replre = re.compile(r'^\s+')
# We need to preserve blank lines while stripping leading whitespace
# so we mark them with '<>', then remove leading whitespace
# and then remove the '<>' markers.
self.replre1 = re.compile(r'^\s*$', re.MULTILINE)
self.replre2 = re.compile(r'^\s+', re.MULTILINE)
self.replre3 = re.compile(r'^<>', re.MULTILINE)

def execute(self, context, self_node, input_node, output_parent):
newtext = re.sub(self.replre, '', input_node.text)
newtext = re.sub(self.replre1, '<>', input_node.text)
newtext = re.sub(self.replre2, '', newtext)
newtext = re.sub(self.replre3, '', newtext)
newnode = deepcopy(input_node)
newnode.text = newtext
output_parent.append( newnode )
Expand Down
85 changes: 59 additions & 26 deletions utils/astxml2markdown.xslt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
<?xml version="1.0"?>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:ast="ast" extension-element-prefixes="ast"
xmlns:ast="ast"
xmlns:str="http://exslt.org/strings"
extension-element-prefixes="ast str"
>

<xsl:output method="text" omit-xml-declaration="yes" indent="no"/>

<xsl:variable name="smallcase" select="'abcdefghijklmnopqrstuvwxyz'" />
<xsl:variable name="uppercase" select="'ABCDEFGHIJKLMNOPQRSTUVWXYZ'" />

<xsl:variable name="tabsize" select="'4'" />
<xsl:variable name="bulletchar" select="'*'" />
<xsl:variable name="bulletindent" select="' '" />

<xsl:template match="text()"/>

Expand Down Expand Up @@ -661,11 +664,10 @@ the XML again with the full descriptions, and forms bulleted lists.
<xsl:template match="info">
<xsl:param name="bulletlevel"/>
<xsl:param name="returntype"/>
<xsl:value-of select="concat(substring($bulletindent, 0, $bulletlevel * 4 + 1), $bulletchar)"/>
<xsl:text> *Technology: </xsl:text>
<xsl:value-of select="@tech"/>
<xsl:text>*&lt;br&gt;</xsl:text>
<xsl:text>&#10;</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding($bulletlevel * $tabsize, ' ')"/>
<xsl:value-of select="concat('* __Technology: ', @tech, '__&#10;')"/>
<xsl:apply-templates>
<xsl:with-param name="returntype">single</xsl:with-param>
<xsl:with-param name="bulletlevel" select="$bulletlevel + 1"/>
Expand Down Expand Up @@ -695,8 +697,10 @@ the XML again with the full descriptions, and forms bulleted lists.

<xsl:template match="parameter">
<xsl:param name="bulletlevel"/>
<xsl:value-of select="concat(substring($bulletindent, 0, $bulletlevel * 4 + 1), $bulletchar, ' ')"/>
<xsl:value-of select="@name"/>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding($bulletlevel * $tabsize, ' ')"/>
<xsl:text>* `</xsl:text><xsl:value-of select="@name"/><xsl:text>`</xsl:text>
<xsl:choose>
<xsl:when test="para">
<xsl:text> - </xsl:text>
Expand All @@ -717,7 +721,10 @@ the XML again with the full descriptions, and forms bulleted lists.
<xsl:template match="argument">
<xsl:param name="bulletlevel"/>
<xsl:param name="separator">,</xsl:param>
<xsl:value-of select="concat(substring($bulletindent, 0, $bulletlevel * 4 + 1), $bulletchar, ' ')"/>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding($bulletlevel * $tabsize, ' ')"/>
<xsl:text>* </xsl:text>
<xsl:if test="@required='true' or @required='yes'">
<xsl:text>**</xsl:text>
</xsl:if>
Expand Down Expand Up @@ -804,20 +811,32 @@ be displayed.

<xsl:template match="note">
<xsl:param name="returntype"/>
<xsl:text>!!! note&#10; </xsl:text>
<xsl:apply-templates select="para">
<xsl:with-param name="returntype" select="$returntype"/>
</xsl:apply-templates>
<xsl:text>&#10;</xsl:text>
<xsl:param name="bulletlevel"/>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding($bulletlevel * $tabsize, ' ')"/>
<xsl:text>/// note
</xsl:text>
<xsl:value-of select="normalize-space(.)"/>
<xsl:text>
///

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

<xsl:template match="warning">
<xsl:param name="returntype"/>
<xsl:text>!!! warning&#10; </xsl:text>
<xsl:apply-templates select="para">
<xsl:with-param name="returntype" select="$returntype"/>
</xsl:apply-templates>
<xsl:text>&#10;</xsl:text>
<xsl:param name="bulletlevel"/>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding($bulletlevel * $tabsize, ' ')"/>
<xsl:text>/// warning
</xsl:text>
<xsl:value-of select="normalize-space(.)"/>
<xsl:text>
///

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

<xsl:template match="variablelist">
Expand All @@ -829,7 +848,10 @@ be displayed.

<xsl:template match="variable">
<xsl:param name="bulletlevel"/>
<xsl:value-of select="concat(substring($bulletindent, 0, $bulletlevel * 4 + 1), $bulletchar, ' ')"/>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding($bulletlevel * $tabsize, ' ')"/>
<xsl:text>* </xsl:text>
<xsl:value-of select="translate(@name, $smallcase, $uppercase)"/>
<xsl:choose>
<xsl:when test="para">
Expand All @@ -845,7 +867,10 @@ be displayed.
<xsl:choose>
<xsl:when test="value">
<xsl:for-each select="value">
<xsl:value-of select="concat(substring($bulletindent, 0, ($bulletlevel + 1) * 4 + 1), $bulletchar, ' ')"/>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding(($bulletlevel + 1) * $tabsize, ' ')"/>
<xsl:text>* </xsl:text>
<xsl:value-of select="translate(@name, $smallcase, $uppercase)"/>
<xsl:choose>
<xsl:when test="string-length(@default) &gt; 0">
Expand All @@ -871,8 +896,10 @@ be displayed.

<xsl:template match="enum">
<xsl:param name="bulletlevel"/>
<xsl:value-of select="concat(substring($bulletindent, 0, $bulletlevel * 4 + 1), $bulletchar, ' ')"/>
<xsl:value-of select="@name"/>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding($bulletlevel * $tabsize, ' ')"/>
<xsl:text>* `</xsl:text><xsl:value-of select="@name"/><xsl:text>`</xsl:text>
<xsl:choose>
<xsl:when test="para">
<xsl:text> - </xsl:text>
Expand All @@ -881,7 +908,8 @@ be displayed.
</xsl:apply-templates>
</xsl:when>
<xsl:otherwise>
<xsl:text>&#10;</xsl:text>
<xsl:text>
</xsl:text>
</xsl:otherwise>
</xsl:choose>
<!--
Expand All @@ -897,9 +925,11 @@ be displayed.
<xsl:with-param name="bulletlevel" select="$bulletlevel + 1"/>
</xsl:apply-templates>
<xsl:apply-templates select="note">
<xsl:with-param name="bulletlevel" select="$bulletlevel + 1"/>
<xsl:with-param name="returntype">single</xsl:with-param>
</xsl:apply-templates>
<xsl:apply-templates select="warning">
<xsl:with-param name="bulletlevel" select="$bulletlevel + 1"/>
<xsl:with-param name="returntype">single</xsl:with-param>
</xsl:apply-templates>
</xsl:template>
Expand All @@ -913,7 +943,10 @@ be displayed.

<xsl:template match="option">
<xsl:param name="bulletlevel"/>
<xsl:value-of select="concat(substring($bulletindent, 0, $bulletlevel * 4 + 1), $bulletchar, ' ')"/>
<xsl:text>
</xsl:text>
<xsl:value-of select="str:padding($bulletlevel * $tabsize, ' ')"/>
<xsl:text>* </xsl:text>
<xsl:value-of select="@name"/>
<xsl:if test="argument">
<xsl:text>`( </xsl:text>
Expand Down