Added fix to ensure that we treat numbered keywords correctly when searching for examples on markdown pages

Author: Gareth Aneurin Tribello

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PlumedToHTML"
-version = "0.118"
+version = "0.119"
 description = "A package for creating prettified HTML for PLUMED files"
 authors = [{ name = "Gareth Tribello", email = "gareth.tribello@gmail.com" }]
 maintainers = [{ name = "Daniele Rapetti", email = "iximiel@gmail.com" }]

src/PlumedToHTML/PlumedFormatter.py

@@ -40,7 +40,13 @@ def format(self, tokensource, outfile):
             if len(action)>0 and (ttype==String or ttype==Keyword or ttype==Comment.Preproc) :
                if action==self.checkaction :
                   for key in keywords :
-                      self.checkaction_keywords.add( key )
+                      if key in self.keyword_dict[action]["syntax"] : 
+                         self.checkaction_keywords.add( key )
+                      else :
+                         # This makes sure we find numbered keywords
+                         for kkkk in self.keyword_dict[action]["syntax"] :
+                             if kkkk=="output" or self.keyword_dict[action]["syntax"][kkkk]["multiple"]==0 : continue
+                             if kkkk in key : self.checkaction_keywords.add( kkkk )
                if notooltips : 
                   # Reset everything for the new action
                   action, label, keywords, notooltips = "", "", [], False

tests/test_keyword_list.py

@@ -22,3 +22,15 @@ def testReadKeywords(self) :
        with open("check_keywords_file", "w") as ofile :
            PlumedToHTML.processMarkdownString( inpt, "check_keyword", ("plumed",), ("master",), actions, ofile, checkaction="PRINT", checkactionkeywords=keyset )
        self.assertTrue( len(keyset)==0 )
+
+       inpt = """
+```plumed
+d1: DISTANCE ATOMS1=1,2 ATOMS2=3,4 
+PRINT ARG=d1 FILE=colvar
+```
+"""
+       actions = set({})
+       keyset = set({"ATOMS","COMPONENTS"})
+       with open("check_keywords_file", "w") as ofile :
+           PlumedToHTML.processMarkdownString( inpt, "check_keyword", ("plumed",), ("master",), actions, ofile, checkaction="DISTANCE", checkactionkeywords=keyset )
+       self.assertTrue( keyset==set({"COMPONENTS"}) )