This is the tag documentation generator for the English-speaking branch of the SCP Wiki.
The documentation generator implements (and is a proof-of-concept of) a prospective interface for defining tags that may in the future be used by Wikijump. Tags are defined as TOML in order to be easily machine-readable, and the documentation is designed to be as human-readable as reasonably possible.
You can see the tag documentation generator and the tag documentation itself in action on 05command, the SCP Wiki's staff site.
This project will be deprecated with the fruition of Wikijump, which will contain native solutions for the problems this tool addresses.
While the tool is designed to be as versatile as possible, please note that it is currently only available in English.
On Wikidot:
[[html]]
<script
id="script"
src="https://scpwiki.github.io/tag-list/tag-list.js?categoryCount=X&site=Y&page=Z"
></script>
[[/html]]
Replace X with the number of tag categories, Y with the URL of the wiki
with the page containing the tag list manifest, and Z with the slug (a.k.a.
"fullname" or "UNIX name") of that page. These parameters will be used to
autofill the input boxes in the tool, enabling most usage to be as simple as
clicking two buttons.
The tool does not need to be on the same page as the tag manifest.
The tool expects that the first code block on the page will contain the documentation template, written as Wikitext with Embedded JavaScript. See our implementation on 05command for an example.
The tool expects that all remaining code blocks on the page will contain TOML files for tag categories.
See instructions for setting up each tag category.
When inserting the TOML into a code block, note that Wikidot does not support
TOML syntax highlighting — we recommend using [[code type="python"]],
which seems to be close enough.
The tool has an input for the URL of the documentation template, and a textarea for the URLs of each category of the tag manifest. With proper query parameter setup, these fields should be filled correctly automatically, but they can be adjusted as needed. There is a button that will fetch these resources from their URLs.
The tool also supports pasting the template or manifest directly.
The tool will output the documentation template with all tags from the manifest inserted. Any errors should be reported immediately, although you may need to check the console for more details.
Install dependencies using npm:
$ npm install
Once this is done, the following scripts are provided as part of the local development process:
$ npm run start # Live view local version in your browser
$ npm run lint # Run linter
$ npm run fix # Run linter in fix mode
$ npm run tests # Run test suite
$ npm run build # Create production build
If there are any issues with this tool, please contact the SCP Wiki Tech Team.