XSLHL Alan Syntax: Fix Predefined Classes

Begin implementing changes discussed in Issue #17: - Add new syntax elements group "classes" to highlight predefined classes: `actor`, `entity`, `location`, `object`, `string`, `thing`. - Remove `actor` and `location` from "keywords" group. - Update stylesheets accordingly. NOTE: Now predefined classes are styled in blue, for testing.
alan-if · Sep 9, 2018 · 9130d0a · 9130d0a
1 parent 332b232
commit 9130d0a
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 9 deletions.
diff --git a/_dev/hl/syntax-highlighting.pdf b/_dev/hl/syntax-highlighting.pdf
diff --git a/manual/Alan_Keywords.txt b/manual/Alan_Keywords.txt
@@ -17,6 +17,30 @@ This is the list of Alan keywords, as found in the Alan Manual (Appendix D, sec.
 'actor' 'add' 'after' 'an' 'and' 'are' 'article' 'at' 'attributes' 'before' 'between' 'by' 'can' 'cancel' 'character' 'characters' 'check' 'container' 'contains' 'count' 'current' 'decrease' 'definite' 'depend' 'depending' 'describe' 'description' 'directly' 'do' 'does' 'each' 'else' 'elsif' 'empty' 'end' 'entered' 'event' 'every' 'exclude' 'exit' 'extract' 'first' 'for' 'form' 'from' 'has' 'header' 'here' 'if' 'import' 'in' 'include' 'increase' 'indefinite' 'initialize' 'into' 'is' 'isa' 'it' 'last' 'limits' 'list' 'locate' 'location' 'look' 'make' 'max' 'mentioned' 'message' 'min' 'name' 'near' 'nearby' 'negative' 'no' 'not' 'of' 'off' 'on' 'only' 'opaque' 'option' 'options' 'or' 'play' 'prompt' 'pronoun' 'quit' 'random' 'restart' 'restore' 'save' 'say' 'schedule' 'score' 'script' 'set' 'show' 'start' 'step' 'stop' 'strip' 'style' 'sum' 'synonyms' 'syntax' 'system' 'taking' 'the' 'then' 'this' 'to' 'transcript' 'until' 'use' 'verb' 'visits' 'wait' 'when' 'where' 'with' 'word' 'words'
 ................................................................................
 
+\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
+                          Predefined Classes Issues                           
+//////////////////////////////////////////////////////////////////////////////
+
+The keywords list contains some predefined classes but not all, so the following
+tokens should be removed from KEYWORDS group (in syntax highlighters) and moved
+into the NATIVE CLASSES group (if supported):
+
+- actor
+- location
+
+And the following should be added to the NATIVE CLASSES group:
+- entity
+- object
+- string
+- thing
+
+
+
+For more details, see Issue #17:
+
+https://github.com/alan-if/alan-docs/issues/17#issuecomment-419701922
+https://github.com/alan-if/alan-docs/issues/17#issuecomment-419704203
+
 ==============================================================================
                           Letter-Cased Keywords List                          
 ==============================================================================

diff --git a/manual/manual-xsl/common.xsl b/manual/manual-xsl/common.xsl
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  "common.xsl" v0.1.2 (2018/09/07)
+  "common.xsl" v0.2.0 (2018/09/09)
   ==============================================================================
   This file was taken from the asciidoctor-fopub project, Copyright (C) 2013
   Dan Allen (MIT License):
@@ -55,9 +55,11 @@
 <!-- Syntax Highlighting Theme for Alan -->
 <!-- ================================== -->
   <xsl:param name="AlanHL.background" select="$Monokai.base00"></xsl:param>
+
   <xsl:param name="AlanHL.normal"     select="$Monokai.base05"></xsl:param>
   <xsl:param name="AlanHL.quotedId"   select="$AlanHL.normal"></xsl:param><!-- TEST WITH base12 -->
   <xsl:param name="AlanHL.keyword"    select="$Monokai.base08"></xsl:param>
+  <xsl:param name="AlanHL.class"      select="$Monokai.base13"></xsl:param>
   <xsl:param name="AlanHL.comment"    select="$Monokai.base04"></xsl:param>
   <xsl:param name="AlanHL.string"     select="$Monokai.base0B"></xsl:param>
   <xsl:param name="AlanHL.number"     select="$Monokai.base10"></xsl:param>

diff --git a/manual/manual-xsl/fo-pdf.xsl b/manual/manual-xsl/fo-pdf.xsl
@@ -147,6 +147,7 @@ PARAGRAPHS WITH COMMENTARY ROLE (indented left)
       <xsl:when test="@role = 'commentary'">
         <xsl:text>4em</xsl:text>
       </xsl:when>
+      <xsl:otherwise>0</xsl:otherwise>
     </xsl:choose>
   </xsl:attribute>
 </xsl:attribute-set>

diff --git a/manual/manual-xsl/highlight.xsl b/manual/manual-xsl/highlight.xsl
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  "highlight.xsl" v0.1.1 (2018/09/07)
+  "highlight.xsl" v0.2.0 (2018/09/09)
   ==============================================================================
   This file was taken from the asciidoctor-fopub project, Copyright (C) 2013
   Dan Allen (MIT License):
@@ -40,6 +40,12 @@
     <fo:inline font-weight="bold" color="{$AlanHL.keyword}"><xsl:apply-templates mode="xslthl"/></fo:inline>
   </xsl:template>
   <!--=====================================================================-->
+  <!--                         PREDEFINED CLASSES                          -->
+  <!--=====================================================================-->
+  <xsl:template match="xslthl:class" mode="xslthl">
+    <fo:inline font-weight="normal" color="{$AlanHL.class}"><xsl:apply-templates mode="xslthl"/></fo:inline>
+  </xsl:template>
+  <!--=====================================================================-->
   <!--                              STRINGS                                -->
   <!--=====================================================================-->
   <xsl:template match="xslthl:string" mode="xslthl">

diff --git a/manual/manual-xsl/xslthl/alan-hl.xml b/manual/manual-xsl/xslthl/alan-hl.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- "alan-hl.xml" v0.1.0 (2018/09/07) | Alan 3.0beta6
+<!-- "alan-hl.xml" v0.2.0 (2018/09/09) | Alan 3.0beta6
 ********************************************************************************
 *                                                                              *
 *                      Alan Interactive Fiction Language                       *
@@ -16,8 +16,8 @@ This syntax definition was created by Tristano Ajmone, (C) 2018, MIT License.
   <!--                               COMMENTS                                -->
   <!--=======================================================================-->
   <highlighter type="oneline-comment">
-    <start>--</start>
     <style>comment</style>
+    <start>--</start>
   </highlighter>
   <!--=======================================================================-->
   <!--                               NUMBERS                                 -->
@@ -43,8 +43,8 @@ This syntax definition was created by Tristano Ajmone, (C) 2018, MIT License.
        (1) parameter indicators: '!', '*'
      ........................................................................-->
   <highlighter type="regex">
-    <pattern>\+|\-|\*|\/|&lt;|(?&lt;!\=)>|&lt;>|&lt;\=|>\=|\=(?!>)|\=\=|\(|\)|\{|\}|!</pattern>
     <style>operator</style>
+    <pattern>\+|\-|\*|\/|&lt;|(?&lt;!\=)>|&lt;>|&lt;\=|>\=|\=(?!>)|\=\=|\(|\)|\{|\}|!</pattern>
   </highlighter>
   <!--=======================================================================-->
   <!--                          QUOTED IDENTIFIERS                           -->
@@ -55,16 +55,15 @@ This syntax definition was created by Tristano Ajmone, (C) 2018, MIT License.
      (eg, 'The Count''s Villa (south exit)').
      ........................................................................-->
   <highlighter type="regex">
-    <pattern>'.*?'(?!'')</pattern>
     <style>quotedId</style>
+    <pattern>'.*?'(?!'')</pattern>
   </highlighter>
   <!--=======================================================================-->
   <!--                               KEYWORDS                                -->
   <!--=======================================================================-->
   <!-- All the keywords, but not the predfined classes:                      -->
   <highlighter type="keywords">
     <ignoreCase />
-    <keyword>actor</keyword><!-- pseudo-attribute, not the class! (as in 'Current actor') -->
     <keyword>Add</keyword>
     <keyword>After</keyword>
     <keyword>An</keyword>
@@ -81,7 +80,7 @@ This syntax definition was created by Tristano Ajmone, (C) 2018, MIT License.
     <keyword>Character</keyword>
     <keyword>Characters</keyword>
     <keyword>Check</keyword>
-    <keyword>Container</keyword><!-- the property, not the class! -->
+    <keyword>Container</keyword>
     <keyword>Contains</keyword>
     <keyword>Count</keyword>
     <keyword>Current</keyword>
@@ -127,7 +126,6 @@ This syntax definition was created by Tristano Ajmone, (C) 2018, MIT License.
     <keyword>Limits</keyword>
     <keyword>List</keyword>
     <keyword>Locate</keyword>
-    <keyword>location</keyword><!-- pseudo-attribute, not the class! (as in 'Current location') -->
     <keyword>Look</keyword>
     <keyword>Make</keyword>
     <keyword>Max</keyword>
@@ -198,6 +196,19 @@ This syntax definition was created by Tristano Ajmone, (C) 2018, MIT License.
     <pattern>\=>|\.|,|:</pattern>
     <style>keyword</style>
   </highlighter>
+  <!--=======================================================================-->
+  <!--                          PREDEFINED CLASSES                           -->
+  <!--=======================================================================-->
+  <highlighter type="keywords">
+    <style>class</style>
+    <ignoreCase />
+    <keyword>actor</keyword>
+    <keyword>entity</keyword>
+    <keyword>location</keyword>
+    <keyword>object</keyword>
+    <keyword>string</keyword>
+    <keyword>thing</keyword>
+  </highlighter>
 </highlighters>
 <!--============================================================================
 MIT License

diff --git a/manual/manual.pdf b/manual/manual.pdf