Improving the Plotscripting Dictionary

From OHRRPGCE-Wiki
Jump to navigation Jump to search

The master copy of the Plotscripting Dictionary is the wip/docs/plotdict.xml file in the SVN repository (docs/plotdict.xml in git). A web browser can display this file directly, and a nightly version of it can be viewed here. There is a UNIX shell script wip/docs/update-html.sh which converts this file into the HTML copy of the Dictionary.

If you want to make improvements to the dictionary, first grab a copy of plotdict.xml. You can either download a full copy of the engine Source Code, or just download [1] and [2] and place them both in the same directory.

However viewing plotdict.xml in a browser is tricky, because sadly recent web browsers generally will refuse to make use of a local .xsl file when you open a .xml. You could try:

  • If you have Python installed, cd into the docs directory, run python3 -m http.server, then visit http://localhost:8000/plotdict.xml (or whichever port python opens)
  • on Unix, run docs/update-html.sh and open plotdictionary.html instead
  • install xsltproc and run xsltproc plotdict.xml > plotdictionary.html

Use a text editor to edit the XML file. One which understands XML is Notepad++, though even Notepad should work. The XML markup used is very simple and you can pick it up easily by looking at other commands; no knowledge of XML is required.

You can submit changes by sending plotdict.xml to one of the Developers or the Mailing List (see Improving the engine).

See Also[edit]