====== StarCat Wiki-Specific Syntax ======

This page contains specific notes on formatting for the StarCat Wiki. See also the standard [[syntax|Formatting Syntax]] page for DokuWiki formatting notes.

===== Mikioplugin (Bootstrap) =====
The installed ''mikioplugin'' (which works with the installed theme) adds some Bootstrap theme elements that you can use on Dokuwiki pages. For a list of the different elements that you can use, see the Mikioplugin wiki at https://github.com/nomadjimbob/mikioplugin/wiki.

==== Icons ====
You can insert icons (like <icon fa binoculars> this) into pages using a snippet like this: <code><icon fa binoculars></code>

You can find a full list of available icons (currently FontAwesome v4) here: https://fontawesome.com/v4/icons/

==== Alerts ====
You can insert alerts (aka admonitions) into pages like this: 

FIXME make this a gist?   --- //thhsh 2025-09-30 15:27//
<code>

<alert>A simple primary alert - check it out!</alert>
<alert secondary>A simple secondary alert - check it out!</alert>
<alert success>A simple success alert - check it out!</alert>
<alert danger>A simple danger alert - check it out!</alert>
<alert warning>A simple warning alert - check it out!</alert>
<alert info>A simple info alert - check it out!</alert>
<alert light>A simple light alert - check it out!</alert>
<alert dark>A simple dark alert - check it out!</alert>
</code>

<alert>A simple primary alert - check it out!</alert>
<alert secondary>A simple secondary alert - check it out!</alert>
<alert success>A simple success alert - check it out!</alert>
<alert danger>A simple danger alert - check it out!</alert>
<alert warning>A simple warning alert - check it out!</alert>
<alert info>A simple info alert - check it out!</alert>
<alert light>A simple light alert - check it out!</alert>
<alert dark>A simple dark alert - check it out!</alert>

===== nspages =====
The installed ''nspages'' plugin lets us list some/all of the pages within that page's namespace. You can find the full documentation here: https://www.dokuwiki.org/plugin:nspages#manual

As a rule of thumb, for a section landing template where you may not (yet) have a full page, you can use this snippet to display the sub-pages and sub-namespaces (sections) within that section:

<code><nspages -h1 -subns -exclude:start -hideNoPages -hideNoSubns -textPages="Pages in this section" -textNS="Subsections in this section"></code> FIXME make this a gist?

<icon fa fire> **Tip:** Use the “lightning bolt” button in the editor toolbar to automatically add this snippet to your page.

It's recommended to add a horizontal rule above the ''nspages'' insert and below any introduction text that you may have for the page.

===== Keyboard =====
To show keyboard buttons like <key>a</key> or <key>CTRL + ALT + DEL</key>, use the following code, or click the keyboard button in the editor toolbar.
<code>
<key>a</key>
<key>CTRL + ALT + DEL</key>
</code>
FIXME make this a gist?  --- //thhsh 2025-09-30 16:01 UTC//

See the [[https://www.dokuwiki.org/plugin:keyboard|keyboard plugin documentation]] for more details.