Config changes for the next round of updates

This commit is contained in:
Tim Van Baak 2019-04-22 13:46:52 -07:00
parent f709efefb8
commit 014ff075c1
1 changed files with 32 additions and 24 deletions

View File

@ -1,11 +1,6 @@
# LEXIPYTHON CONFIG FILE # LEXIPYTHON CONFIG FILE
# #
# This file defines the configuration values for an instance of Lexipython. # This file defines the configuration values for an instance of Lexipython.
# Configuration values are written as:
>>>CONFIG_NAME>>>
value
<<<CONFIG_NAME<<<
# The above defines a config value named CONFIG_NAME with a value of "value".
# The title of the Lexicon game, displayed at the top of each entry. # The title of the Lexicon game, displayed at the top of each entry.
>>>LEXICON_TITLE>>> >>>LEXICON_TITLE>>>
@ -29,33 +24,46 @@ logo.png
<p>Put session information here, like the index grouping and turn count, where to send completed entries, index assignments, turn schedule, and so on.</p> <p>Put session information here, like the index grouping and turn count, where to send completed entries, index assignments, turn schedule, and so on.</p>
<<<SESSION_PAGE<<< <<<SESSION_PAGE<<<
# Index headers. An index is a string of characters, which are the characters # Index headers. An index header is declared as id:pattern or id[pri]:pattern.
# an entry has to begin with to fall under that index. Indices will be listed # An article is sorted under the first index it matches. Indices are checked
# in the order written. Entries will be put into the first index they match. # first in descending order of pri and in list order at each value of pri.
# Leftover entries will be listed under "&c." at the end. # An undefined pri value is 0.
# A character index has id "char". An article matches a character index if the
# first letter of its title is one of the characters in the index's pattern.
# A prefix index has id "prefix". An article matches a prefix index if the
# title begins with the pattern.
# The etc index has id "etc". An article always matches the etc index. The
# pattern is used as the index display name.
>>>INDEX_LIST>>> >>>INDEX_LIST>>>
ABC char:ABC
DEF char:DEF
GHI char:GHI
JKL char:JKL
MNO char:MNO
PQRS char:PQRS
TUV char:TUV
WXYZ char:WXYZ
etc:&c.
<<<INDEX_LIST<<< <<<INDEX_LIST<<<
# The default sorting to use on the contents page. # The default sorting to use on the contents page.
# Allowed values are "?byturn" and "?byindex". # Allowed values are "turn", "player", and "index"
>>>DEFAULT_SORT>>> >>>DEFAULT_SORT>>>
?byturn index
<<<DEFAULT_SORT<<< <<<DEFAULT_SORT<<<
# Flag to enable addendum articles. If enabled, articles with the same title
# and a later turn than another article will be appended to that article.
>>>ALLOW_ADDENDA>>>
False
<<<ALLOW_ADDENDA<<<
# Graphviz file name. If present, the graph of page citations will be written # Graphviz file name. If present, the graph of page citations will be written
# in the dot file format. # in the .dot format.
>>>GRAPHVIZ_FILE>>> >>>GRAPHVIZ_FILE>>>
<<<GRAPHVIZ_FILE<<< <<<GRAPHVIZ_FILE<<<
# Print version file name. If present, the lexicon will be compiled and written # Searchable version file name. If present, the lexicon will be compiled and
# into a single print-ready HTML file. # written into a single, easily-searchable HTML file.
>>>PRINTABLE_FILE>>> >>>SEARCHABLE_FILE>>>
<<<PRINTABLE_FILE<<< <<<SEARCHABLE_FILE<<<