Add element schema

Author: Fernando-A-Rocha

elements/player.yaml

@@ -1,4 +1,4 @@
-name: 'Player'
+name: 'player'
 description: |
   The player class represents pedestrians controlled by clients. A player element is created when a client connects to the server and destroyed when that client quits. Players cannot be created or destroyed otherwise.
 

schemas/element.yaml

@@ -0,0 +1,24 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: /schemas/element
+title: Element schema
+type: object
+required:
+  - name
+  - description
+properties:
+  name:
+    type: string
+    description: Lowercase name of the element.
+  description:
+    type: string
+    description: Description of the element.
+  see_also:
+    type: array
+    description: |
+      A list of other categories for further reading.
+      Every element will implicitly display it's own category in *See Also*, unless you
+      introduce this property, then you have to be explicit about it.
+    items:
+      type: string
+      pattern: "^(category):"
+      uniqueItems: true

tools/validate.cmd

@@ -4,6 +4,10 @@ for /r "functions" %%f in (*.yaml) do (
     .\tools\yajsv.exe -s schemas/function.yaml "%%f"
 )
 
+for /r "elements" %%f in (*.yaml) do (
+    .\tools\yajsv.exe -s schemas/element.yaml "%%f"
+)
+
 for /r "articles" %%f in (*.yaml) do (
     .\tools\yajsv.exe -s schemas/article.yaml "%%f"
 )

tools/validate.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
 
 find 'functions/' -name '*.yaml' -type f -print0 | xargs -0 -I {} tools/yajsv -s schemas/function.yaml {}
+find 'elements/' -name '*.yaml' -type f -print0 | xargs -0 -I {} tools/yajsv -s schemas/element.yaml {}
 find 'articles/' -name '*.yaml' -type f -print0 | xargs -0 -I {} tools/yajsv -s schemas/article.yaml {}

web/resources/element.html

@@ -2,7 +2,7 @@
 <!-- Title -->
 <div class="floating-right1" style="color: #ccc;">Element</div>
 <h1 style="border-bottom: 3px solid #ccc; padding-bottom: 0.2em;">
-    {{ element.name }}
+    {{ element.name|capitalize }}
     <a class="small-fs" href="#" onclick="copyText('{{ element.name }}', 'copy-{{ element.name }}')"><i class="fa-regular fa-copy"></i> <span id="copy-{{ element.name }}"></span> </a>
 </h1>
 

web/scripts/builder.py

@@ -51,6 +51,8 @@ def clear(self):
     def load_schemas(self):
         try:
             self.schema_function = utils.load_schema(os.path.join(DOCS_REPO_PATH, 'schemas/function.yaml'))
+            # self.schema_event = utils.load_schema(os.path.join(DOCS_REPO_PATH, 'schemas/event.yaml'))
+            self.schema_element = utils.load_schema(os.path.join(DOCS_REPO_PATH, 'schemas/element.yaml'))
             self.schema_article = utils.load_schema(os.path.join(DOCS_REPO_PATH, 'schemas/article.yaml'))
         except Exception as e:
             raise WikiBuilderError(f'Error loading schemas: {e}')
@@ -63,7 +65,7 @@ def parse_elements(self):
                 if filename.endswith('.yaml'):
                     file_path = os.path.join(root, filename)
                     try:
-                        element = utils.load_yaml(file_path)
+                        element = utils.load_and_validate_yaml(file_path, self.schema_element)
 
                         element['real_path'] = file_path
                         element['description_html'] = utils.to_html(element['description'])
@@ -343,7 +345,7 @@ def render_page(self, title, content):
 
     def create_element_page(self, element):
         element_template = self.input_env.get_template('element.html')
-        html_content = self.render_page(element['name'], element_template.render(element=element))
+        html_content = self.render_page(element['name'].capitalize(), element_template.render(element=element))
 
         web_path = f"/{element['name']}/"
         element_folder = OUTPUT_HTML_PATH + web_path
@@ -483,7 +485,7 @@ def create_category(self, web_path, category_data):
     def create_404_page(self):
         path_template = '404.html'
         template = self.input_env.get_template(path_template)
-        html_content = self.render_page(path_template, template.render())
+        html_content = self.render_page('Page not found', template.render())
 
         output_path = os.path.join(OUTPUT_HTML_PATH, path_template)
         with open(output_path, 'w') as html_file: