pangamebook/game.md

74 lines
3 KiB
Markdown
Raw Permalink Normal View History

---
title: Pangamebook Gamebook Example
author: Pelle Nilsson
---
2021-04-24 11:34:55 +03:00
This is just an example to give new users and idea where to start. See [Pandoc
Getting Started Article](https://pandoc.org/getting-started.html) and
[PangamebookREADME](README.md) for more information.
The lines at the very top of this file are needed to add some metadata
for the book. Otherwise there are ugly warnings when creating EPUB files
and possibly for other formats as well. Good to always include some
lines like that. Normally they are invisible and should not show
up in the output at all.
2021-04-24 11:34:55 +03:00
# Introduction
Sections with a header like this one will not be affected by the Pangamebook
filter, as described in the README.
# 1
This is where the story begins. That the header says just 1 like that means
that Pangamebook will keep it as it is, and not move it around.
From here you can move on to [second] or [third] section. If you read
this in the original Markdown file (example.md) you can tell that
the names of those sections are used as links (in square brackets).
Running Pandoc with the Pangamebook filter will change the links
to the correct numbers after shuffling all sections, so "second"
and "third" might end up not being 2 or 3 at all.
# second
This is the first header in the book that Pangamebook will see. Only
lower-case letters. It could have had some digits and underscores in
there as well, but anything else will make Pangamebook think it is
not part of the story you want to shuffle or number.
Here is another link to the third section: [third]. You
can also go on to [some_other_section].
# third
Just another example section. Did you know that you can put images and tables
and many other useful things in Pandoc Markdown files? There are no examples of
that here, but it can be useful to know. Guess the story ends here as there are
no links going out from this section.
# 5
Another header that is already a number. If you paid attention to
the description in the [README](README.md) you know that this
section will not be shuffled with other sections. Also notice
that the sections before ("second" and "third") will not be
moved to after this one, and the sections below will not move
to before. Many books might not need to ever have any fixed
numbers like this, but it can be used to keep sections grouped.
If you add two more sections before this there will be an
error, because there is not room for four sections between
1 and 5.
# some_other_section
This is just to continue the example with something after
section [5] that was fixed, and that this should always
have number 6 or higher. The story ends in section [10].
# unreached
There are not links to this section, but it should still
show up.
# 10
This ends the story. Most books have a best ending that has
the highest number in the book. Setting this to 10 here leaves
some margins if a few more sections are added before.
# Epilogue
Of course some non-gamebook sections like this can show up
later in the book as well. Remember Capitalized Headings
are ignored.