From 13683a35b46e8d319b20318a46db4d7dff89249e Mon Sep 17 00:00:00 2001 From: Bill Niblock Date: Sat, 6 May 2017 18:16:22 -0400 Subject: [PATCH] Update documentation --- doc/Dialogue.html | 2 +- doc/Dialogue/Speaker.html | 2 +- doc/Gardner.html | 2 +- doc/Planter.html | 2 +- doc/Sapling.html | 2 +- doc/Sapling/CLI.html | 2 +- doc/_index.html | 2 +- doc/file.CONTRIBUTING.html | 2 +- doc/file.LICENSE.html | 2 +- doc/file.README.html | 2 +- doc/file.config_file.html | 2 +- doc/file.config_file_example.html | 2 +- doc/file.editor.html | 2 +- doc/index.html | 2 +- doc/top-level-namespace.html | 2 +- docs/config_file.md | 66 --------------------------- docs/config_file_example.md | 42 ------------------ docs/config_file_example.yaml | 37 ---------------- docs/editor.md | 16 ------- trees/example_quest.yaml | 74 ------------------------------- 20 files changed, 15 insertions(+), 250 deletions(-) delete mode 100644 docs/config_file.md delete mode 100644 docs/config_file_example.md delete mode 100644 docs/config_file_example.yaml delete mode 100644 docs/editor.md delete mode 100644 trees/example_quest.yaml diff --git a/doc/Dialogue.html b/doc/Dialogue.html index 66a5468..8e05121 100644 --- a/doc/Dialogue.html +++ b/doc/Dialogue.html @@ -116,7 +116,7 @@ diff --git a/doc/Dialogue/Speaker.html b/doc/Dialogue/Speaker.html index 541b5ec..92b7f7a 100644 --- a/doc/Dialogue/Speaker.html +++ b/doc/Dialogue/Speaker.html @@ -535,7 +535,7 @@ reached.

diff --git a/doc/Gardner.html b/doc/Gardner.html index ff1c492..5ca76ef 100644 --- a/doc/Gardner.html +++ b/doc/Gardner.html @@ -728,7 +728,7 @@ diff --git a/doc/Planter.html b/doc/Planter.html index 933e3e9..7b82fd1 100644 --- a/doc/Planter.html +++ b/doc/Planter.html @@ -106,7 +106,7 @@ diff --git a/doc/Sapling.html b/doc/Sapling.html index d0cdff2..e5a4e99 100644 --- a/doc/Sapling.html +++ b/doc/Sapling.html @@ -117,7 +117,7 @@ world starts building.

diff --git a/doc/Sapling/CLI.html b/doc/Sapling/CLI.html index e2405ee..51e6c10 100644 --- a/doc/Sapling/CLI.html +++ b/doc/Sapling/CLI.html @@ -282,7 +282,7 @@ editing/creating a tree.

diff --git a/doc/_index.html b/doc/_index.html index 5ca7088..0ad8a13 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -173,7 +173,7 @@ diff --git a/doc/file.CONTRIBUTING.html b/doc/file.CONTRIBUTING.html index a9c599c..fb05c4f 100644 --- a/doc/file.CONTRIBUTING.html +++ b/doc/file.CONTRIBUTING.html @@ -74,7 +74,7 @@ feel free to submit an issue or reach out to me directly.

diff --git a/doc/file.LICENSE.html b/doc/file.LICENSE.html index 6cdece4..75a1ae6 100644 --- a/doc/file.LICENSE.html +++ b/doc/file.LICENSE.html @@ -82,7 +82,7 @@ DEALINGS IN THE SOFTWARE.

diff --git a/doc/file.README.html b/doc/file.README.html index 1f05369..4468c94 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -131,7 +131,7 @@ guidelines. diff --git a/doc/file.config_file.html b/doc/file.config_file.html index d00eccb..12013e7 100644 --- a/doc/file.config_file.html +++ b/doc/file.config_file.html @@ -126,7 +126,7 @@ branch", and the program will end after reaching it. diff --git a/doc/file.config_file_example.html b/doc/file.config_file_example.html index b1e305c..3a46390 100644 --- a/doc/file.config_file_example.html +++ b/doc/file.config_file_example.html @@ -100,7 +100,7 @@ diff --git a/doc/file.editor.html b/doc/file.editor.html index a87198b..3a42c19 100644 --- a/doc/file.editor.html +++ b/doc/file.editor.html @@ -72,7 +72,7 @@ allows for editing all parts of a tree, from the trunk to the leaves.

diff --git a/doc/index.html b/doc/index.html index 7f33759..6476ee2 100644 --- a/doc/index.html +++ b/doc/index.html @@ -131,7 +131,7 @@ guidelines. diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index 0e0f006..33af615 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -100,7 +100,7 @@ diff --git a/docs/config_file.md b/docs/config_file.md deleted file mode 100644 index 689a591..0000000 --- a/docs/config_file.md +++ /dev/null @@ -1,66 +0,0 @@ - - -# Configuration File Documentation - -The configuration file for `sapling` is a standard YAML file. The general -outline looks something like this: - - --- - - - trunk: "This is a description of the dialogue tree." - - - branch: - number: 1 - text: "This is the overall text for the branch." - leaf: - - - text: "This is option 1." - branch: 2 - - - text: "This is option 2." - branch: 3 - - - branch: - number: 2 - text: "This is the overall text for the branch." - leaf: - - - text: "This is option 1." - branch: 1 - - - text: "This is option 2." - branch: 3 - - - branch: - number: 3 - text: "This is the overall text for the branch." - -## Outline - -#### Trunk - -The `trunk` is a metadata list. Currently, the only information we really care -about is a general description for the tree. Because of this, `trunk` is the -key, and the description is the value. - -#### Branch - -Branches are the content of a dialogue tree. Each `branch` has the following -options: - -- `number`: The branch number. This is how leaves get around. It must be unique. -- `text`: The text provided by getting to this branch. The first branch is shown - by default when the tree is opened. -- `leaf`: [Optional] The list of options for the branch. Details for leaves are - below. If no leaves are provided, the branch is considered a "terminal - branch", and the program will end after reaching it. - -#### Leaf - -Leaves are the options of a branch. Each `leaf` has the following options: - -- `text`: The text shown as the option. -- `branch`: The branch this option takes the user to. diff --git a/docs/config_file_example.md b/docs/config_file_example.md deleted file mode 100644 index 8a9acdd..0000000 --- a/docs/config_file_example.md +++ /dev/null @@ -1,42 +0,0 @@ - -# Example Dialogue Tree - --- - # The trunk is a general introduction to the tree. It shouldn't include any - # thematic details, rather a one-liner to let the user know what they're getting - # into. - - - trunk: "This is a general introduction to the dialogue tree." - - # Branches are the content of a dialogue tree. Each branch is numbered, and that - # number is used as the primary means of navigation. The text of a branch is the - # story provided to the user; the result of getting to the branch. The leaves - # (the section titled leaf) represent the options. Options are displayed in the - # order they appear. Within a leaf, the text is what the option says, and the - # branch is the branch number which this option will lead to. Leading to branch - # number 0 will immediately exit the program. - # - # You can have as many branches and leaves as you wish, though having too many - # leaves may lead to both display problems, and paralyzing indecision. - - - branch: - number: 1 - text: "The first branch. Displayed first, by default." - leaf: - - - text: "The first option for this branch. It leads to branch 2" - branch: 2 - - - text: "The second branch. It immediately exits the program." - branch: 0 - - # A terminal branch is a branch which has no leaves. This represents an ending. - # Once a user hits a terminal branch, the program will display the branch text, - # and then redirect the user to branch 0, to exit. - - - branch: - number: 2 - text: "This is a terminal branch. After displaying this text, - the program will exit." diff --git a/docs/config_file_example.yaml b/docs/config_file_example.yaml deleted file mode 100644 index 1a6551e..0000000 --- a/docs/config_file_example.yaml +++ /dev/null @@ -1,37 +0,0 @@ -# @title Example YAML File ---- -# The trunk is a general introduction to the tree. It shouldn't include any -# thematic details, rather a one-liner to let the user know what they're getting -# into. -- trunk: "This is a general introduction to the dialogue tree." - -# Branches are the content of a dialogue tree. Each branch is numbered, and that -# number is used as the primary means of navigation. The text of a branch is the -# story provided to the user; the result of getting to the branch. The leaves -# (the section titled leaf) represent the options. Options are displayed in the -# order they appear. Within a leaf, the text is what the option says, and the -# branch is the branch number which this option will lead to. Leading to branch -# number 0 will immediately exit the program. -# -# You can have as many branches and leaves as you wish, though having too many -# leaves may lead to both display problems, and paralyzing indecision. -- - branch: - number: 1 - text: "The first branch. Displayed first, by default." - leaf: - - - text: "The first option for this branch. It leads to branch 2" - branch: 2 - - - text: "The second branch. It immediately exits the program." - branch: 0 - -# A terminal branch is a branch which has no leaves. This represents an ending. -# Once a user hits a terminal branch, the program will display the branch text, -# and then redirect the user to branch 0, to exit. -- - branch: - number: 2 - text: "This is a terminal branch. After displaying this text, - the program will exit." diff --git a/docs/editor.md b/docs/editor.md deleted file mode 100644 index 5b4106e..0000000 --- a/docs/editor.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Sapling Editor - -Sapling provides an editor for creating and modifying dialogue trees. The editor -allows for editing all parts of a tree, from the trunk to the leaves. - -## Creating a new tree - -Pending - -## Editing an existing tree - -Pending diff --git a/trees/example_quest.yaml b/trees/example_quest.yaml deleted file mode 100644 index e27b566..0000000 --- a/trees/example_quest.yaml +++ /dev/null @@ -1,74 +0,0 @@ ---- -- trunk: "Example Quest: Learn what it looks like to use Sapling!" - -- - branch: - number: 1 - text: "You stumble upon the first branch of a dialogue tree. - You find yourself at a junction..." - leaf: - - - text: "Go to the next branch." - branch: 2 - - - text: "Go to the frigid north-lands, because there's always a - frigid north-lands." - branch: 3 - - - text: "Leave this silly place, but with a reason." - branch: 5 - - - text: "Leave this silly place immediately, without any reason." - branch: 0 -- - branch: - number: 2 - text: "Ye find ye-self at branch 2. Your options are north, south - or Dennis." - leaf: - - - text: "North, to frigidity!" - branch: 3 - - - text: "South, back the way you came!" - branch: 1 - - - text: "Dennis" - branch: 6 -- - branch: - number: 3 - text: "It's cold up here. You decide to go someplace else!" - leaf: - - - text: "Head on home." - branch: 4 - - - text: "Head south (back the way you came)" - branch: 2 -- - branch: - number: 4 - text: "You head on home! Bye bye!" -- - branch: - number: 5 - text: "You leave the dialogue tree, and all its textual glory, behind - and go find a nice GUI to settle down with." -- - branch: - number: 6 - text: "Dennis appreciates your interest, but is really just trying to - hangout and play video games." - leaf: - - - text: "Join Dennis, and play video games with him." - branch: 7 - - - text: "Reconsider your options." - branch: 2 -- - branch: - number: 7 - text: "You sit down next to Dennis, and together you conquer all sorts of - realms and wizards and stuff. Nice!"