github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/userguide-md-cat.tmpl.md (about)

     1  {{ if env "DOCGEN_TARGET=vuepress" }}---
     2  title: {{ md .Title }}
     3  index: true
     4  category:
     5    - {{ md .ID }}
     6  ---
     7  
     8  {{ end }}<h1>{{ md .Title }}</h1>{{ if .Description }}
     9  
    10  {{ md .Description }}{{ end }}
    11  
    12  {{ if env "DOCGEN_TARGET=" }}<h2>Table of Contents</h2>
    13  
    14  <div id="toc">
    15  
    16  - [Language Tour](#language-tour)
    17  - [User Guides](#user-guides)
    18  - [Builtin Commands](#builtin-commands)
    19    - [Standard Builtins](#standard-builtins)
    20    - [Optional Builtins](#optional-builtins)
    21  - [Data Types](#data-types)
    22  - [Events](#events)
    23  - [API Reference](#api-reference)
    24  
    25  </div>
    26  {{ end }}
    27  ## Language Tour
    28  
    29  The [Language Tour](/tour.md) is a great introduction into the Murex language.
    30  
    31  ## User Guides
    32  
    33  {{ if .Documents }}{{ range $i,$a := .Documents }}{{ if gt $i 0 }}
    34  {{ end }}* [{{ md .Title }}](../{{ md .Hierarchy }}.md):
    35    {{ md .Summary }}{{ end }}{{ else }}No pages currently exist for this category.{{ end }}
    36  
    37  {{ if env "DOCGEN_TARGET=" }}## Operators And Tokens
    38  
    39  {{ if otherdocs "parser" }}{{ range $i,$a := otherdocs "parser" }}{{ if gt $i 0 }}
    40  {{ end }}* [{{ md .Title }}]({{ md .Hierarchy }}.md):
    41    {{ md .Summary }}{{ end }}{{ else }}No pages currently exist for this category.{{ end }}
    42  
    43  ## Builtin Commands
    44  
    45  ### Standard Builtins
    46  
    47  {{ if otherdocs "commands" }}{{ range $i,$a := otherdocs "commands" }}{{ if gt $i 0 }}
    48  {{ end }}* [{{ md .Title }}](../{{ md .Hierarchy }}.md):
    49    {{ md .Summary }}{{ end }}{{ else }}No pages currently exist for this category.{{ end }}
    50  
    51  ### Optional Builtins
    52  
    53  These builtins are optional. `select` is included as part of the default build
    54  but can be disabled without breaking functionality. The other optional builtins
    55  are only included by default on Windows.
    56  
    57  {{ if otherdocs "optional" }}{{ range $i,$a := otherdocs "optional" }}{{ if gt $i 0 }}
    58  {{ end }}* [{{ md .Title }}](../{{ md .Hierarchy }}.md):
    59    {{ md .Summary }}{{ end }}{{ else }}No pages currently exist for this category.{{ end }}
    60  
    61  ## Data Types
    62  
    63  {{ if otherdocs "types" }}{{ range $i,$a := otherdocs "types" }}{{ if gt $i 0 }}
    64  {{ end }}* [{{ md .Title }}](../{{ md .Hierarchy }}.md):
    65    {{ md .Summary }}{{ end }}{{ else }}No pages currently exist for this category.{{ end }}
    66  
    67  ## Events
    68  
    69  {{ if otherdocs "events" }}{{ range $i,$a := otherdocs "events" }}{{ if gt $i 0 }}
    70  {{ end }}* [{{ md .Title }}](../{{ md .Hierarchy }}.md):
    71    {{ md .Summary }}{{ end }}{{ else }}No pages currently exist for this category.{{ end }}
    72  
    73  ## API Reference
    74  
    75  These API docs are provided for any developers wishing to write their own builtins.
    76  
    77  {{ if otherdocs "apis" }}{{ range $i,$a := otherdocs "apis" }}{{ if gt $i 0 }}
    78  {{ end }}* [{{ md .Title }}](../{{ md .Hierarchy }}.md):
    79    {{ md .Summary }}{{ end }}{{ else }}No pages currently exist for this category.{{ end }}
    80  {{ end }}