Skip to content

Commit

Permalink
Fixed typos in documentation. Thanks Eforney!
Browse files Browse the repository at this point in the history
  • Loading branch information
dlareau committed Mar 6, 2020
1 parent fc66781 commit 5931f43
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 46 deletions.
45 changes: 25 additions & 20 deletions docs/hunt_creation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ template field and then skip to "Hint Unlock Plans" below.

Editing the Hunt Template
-------------------------
This is where we give the hunt it's look and feel. Before this point, navigating
This is where we give the hunt its look and feel. Before this point, navigating
to the hunt page would just give you a blank page.

Basic information
Basic Information
^^^^^^^^^^^^^^^^^

Everything typed into the "Template" form on the hunt editing page will be run
Expand All @@ -97,7 +97,7 @@ for use in the template:

Since version 3.0, in order to reduce repository clutter, it is now against
policy to commit files specific to a certain hunt to the repository. This means
that you are no longer allowed load resource files directly onto the server.
that you are no longer allowed to load resource files directly onto the server.

To still allow the use of new static files in each hunt, there is now a field on
each hunt's admin page for a resource URL. This URL should point to a publicly
Expand All @@ -111,7 +111,7 @@ resource directory. For example, putting the text
``{% hunt static %}myimage.png`` in the template would insert the URL to the
file ``myimage.png``.

Inheriting the base template
Inheriting the Base Template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

It is recommended to start your template out with the following code:
Expand Down Expand Up @@ -158,14 +158,14 @@ https://docs.djangoproject.com/en/2.2/ref/templates/language/#template-inheritan
template to get nice features like the header bar, common style sheets,
Google analytics, and graceful degradation when the hunt becomes public.

Starter example
Starter Example
^^^^^^^^^^^^^^^

While you may now technically have all of the information you need, that
doesn't mean you know what to do with it. Below is a simple example based one of
our first hunts to use this server. It will show the puzzles, display the
answer for any solved puzzles, and demonstrates how to insert a break a hunt
into two rounds.
answer for any solved puzzles, and demonstrates how to break a hunt into two
rounds.

.. code-block:: html

Expand Down Expand Up @@ -232,12 +232,12 @@ into two rounds.
{% endblock content %}


Template wrap up
Template Wrap Up
^^^^^^^^^^^^^^^^

That should be enough to get you started with template writing. Don't forget to
download resources each time you update them and save often when editing the
template as it won't save when if you close or leave the page for any reason.
template as it won't save if you close or leave the page for any reason.

.. Tip:: You can use ctrl-s/cmd-s to save the page and continue working

Expand All @@ -246,7 +246,7 @@ Hint Unlock Plans
-----------------

The final section of the Hunt creation page is for determining if and when hints
will automatically be become available to teams. If you do not want to use
will automatically become available to teams. If you do not want to use
automatic hints (or hints at all) in the current hunt, simply ignore this
section. Manual hints can still be awarded from the "Hints" page under the
"Other Staff Pages" sidebar header.
Expand Down Expand Up @@ -279,6 +279,11 @@ plans will trigger independently of each other.
that the start date is actually when teams will start solving puzzles and not
just when teams arrive for check in.

.. Danger::
Changing a hint unlock plan after the hunt has started can have unexpected
results. Please take extra care to make sure that the hint plans are correct
before the hunt starts.

Hunt object creation wrap up
----------------------------

Expand All @@ -290,7 +295,7 @@ Create Puzzle Objects
=====================

Great, now we have a hunt template and we can view our hunt, but that's not good
without any puzzles, so lets add some.
without any puzzles, so let's add some.

Start by going to the "Puzzles" section using the side navbar and clicking the
blue "+" button in the upper right-hand corner to be brought to the puzzle
Expand All @@ -305,7 +310,7 @@ name and an answer.
.. Tip:: Answers are not case sensitive

Next, the puzzle must be given both a number and an ID. The number is for
ordering withing the hunt, and controls the order of puzzle objects passed into
ordering within the hunt, and controls the order of puzzle objects passed into
the hunt template. The ID used as a unique identifier across all puzzles is used
in the URL for the puzzle.

Expand Down Expand Up @@ -344,11 +349,11 @@ Puzzle content is controlled by the following three links:
"Resource link"
The link to a publicly accessible ZIP file of the puzzle contents if the
puzzle is an HTML puzzle. The ZIP file must contain a file named "index.html".
All links from the index file to other files in the ZIP file puzzle content
should be relative as the base URL of the final contents is not guaranteed.
All links from the index file to other files in the ZIP file should be
relative links, as the base URL of the final contents is not guaranteed.

"Solution link"
The link to a publicly accessible PDF of the puzzle solution. If this filed is
The link to a publicly accessible PDF of the puzzle solution. If this field is
filled in, the solutions for each puzzle will be available on the puzzle page
after the hunt is over.

Expand All @@ -365,7 +370,7 @@ now four options for puzzle unlocking:
Solves Based Unlock:
The puzzle will be unlocked once a certain number of puzzles from a chosen
subset are solved. Use the puzzle chooser to indicate which puzzles count
towards unlocking this puzzle. Then enter the number of puzzle required to
towards unlocking this puzzle. Then enter the number of puzzles required to
unlock this puzzle in the "Num required to unlock" field. Setting the number
of required puzzles to zero means that this puzzle will automatically be
unlocked when the hunt starts.
Expand Down Expand Up @@ -405,12 +410,12 @@ than one regex will result in undefined behavior.
.. Tip:: Response text can contain links using markdown style format:
[foo](https://link.to.foo)

Puzzle wrapup
Puzzle Wrapup
-------------

After filling out everything on the puzzle creation page, hit "Save and add
another"and continue to add puzzles until you have added all of the puzzles for
the hunt. This will take a while, my recommendations are to be patient and have
another" and continue to add puzzles until you have added all of the puzzles for
the hunt. This will take a while; my recommendations are to be patient and have
the unlocking graph on hand.


Expand Down Expand Up @@ -483,7 +488,7 @@ basic template, in this case the template name is ``prepuzzle.html``.

The following blocks are available to override in the prepuzzle template:

{%block title %}
{% block title %}
This block controls what title is in the web browser tab. The default value
for this block is the puzzle name.

Expand Down
49 changes: 23 additions & 26 deletions docs/hunt_running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ messages will be shown in red.

.. Attention:: Due to the technical limitations of the server, only messages
that have arrived while the chat page is open will cause the teams' name to
turn red, so try not to refresh the page too often after the hunt starts. Its
also not a bad idea to click around the teams every so often to make sure
something hasn't slipped through the cracks.
turn red, so try not to refresh the page too often after the hunt starts.
It's also not a bad idea to click around the teams every so often to make
sure something hasn't slipped through the cracks.

It is possible to check the checkbox at the bottom to "Make the message an
announcement". This will send the message to all teams in the hunt.
Expand All @@ -112,9 +112,9 @@ number of hints they currently have available to them. Clicking the plus and
minus buttons next to the number of available hints will give or take away
available hints from the team.

.. Note:: There is a very small chance that the team naturally gains a hint in
same time period that you click to give them a hint. The counter will tick up
by two in that case, you probably didn't double click.
.. Note:: There is a very small chance that the team will naturally gain a hint
in the same time period that you click to give them a hint. The counter will
tick up by two in that case, you probably didn't double click.

Management Page
---------------
Expand Down Expand Up @@ -144,19 +144,19 @@ allows the downloading of resources for any chosen prepuzzle.
Finally, there is a single button at the bottom of the page titled "Reset all
progress". This button resets all team interaction that has happened so far with
a hunt, all submissions, responses, unlocks, solves, hints, and chat messages
are deleted. Normally only used once between playtesting and the start of the
hunt.
are deleted. This is normally only used once between playtesting and the start
of the hunt.

Info Page
---------

The info page lists information about teams that are signed up for hunt and the
people on them. Along the left is a list of all of the teams separated into 3
categories: "Needs a room", "Has a room", and "Off Campus" with each team having
a text box next to their name with their current location. You can bulk edit
team locations, for example assigning rooms to "Need a room" teams, and then
click the "Update Locations" button at the bottom to save all the edits for a
certain section.
The info page lists information about teams that are signed up for a hunt and
the people on them. Along the left is a list of all of the teams separated into
3 categories: "Needs a room", "Has a room", and "Off Campus" with each team
having a text box next to their name with their current location. You can bulk
edit team locations, for example assigning rooms to "Need a room" teams, and
then click the "Update Locations" button at the bottom to save all the edits for
a certain section.

.. Note:: Teams are listed in signup order with the first team to sign up at the
top so rooms can be assigned easily in sign up order.
Expand Down Expand Up @@ -199,11 +199,11 @@ Before anybody can start playing your hunt, you have to download the puzzles.
Sign into the staff part of the website located at ``{server URL}/staff`` and
head over to the "Management" page located under the "Other Staff Pages" sidebar
header. From there, click the "Puzzles" button next to the current hunt, which
will download all of the puzzles. It take a few minutes, be patient.
will download all of the puzzles. It takes a few minutes, be patient.

That should just work, if it doesn't, check your links, check your PDF
accessibility and try again. (if you really think it is a bug, feel free to
submit an issue)
That should just work. If it doesn't, check your links and PDF accessibility and
try again. (If you really think it is a bug, feel free to submit an issue on the
github project)

If any individual puzzle fails to download or you just want to re-download a
single puzzle for some reason, remember that you can un-collapse the hunt and
Expand All @@ -214,7 +214,7 @@ Playtesting

You probably want people to test your hunt before the actual event. This is easy
using the puzzlehunt server. Just have the team of playtesters sign up like
normal, then navigate to the "Teams" page on the sidebar, find the team,
normal. Then navigate to the "Teams" page on the sidebar, find the team,
check the "Playtester" checkbox on their edit page, fill in the playtest start
and end dates and save the team. They will then have access to the puzzlehunt as
if it was open to them during the given dates.
Expand All @@ -223,7 +223,7 @@ if it was open to them during the given dates.
team playtest as of version 4.0 due to the number of time based features now
available.

All interactions with the playtest team should can be done as they normally
All interactions with the playtest team should be done as they normally
would be through the various staff pages described above. Things like the queue,
the progress page, chat, puzzle unlocking, and hints should all work. The only
feature currently not working for playtest teams is time released hints. If you
Expand All @@ -250,15 +250,12 @@ Before the hunt:
- [ ] Ensure all puzzles have working PDFs and images
- [ ] Ensure teams have been assigned rooms on the info page

TODO: Fix: Ensure that all teams show puzzles as unlocked on the progress page
(now happening automatically)

During the Hunt
---------------

Hopefully your opening information session went well, the puzzles released
flawlessly and people are now solving puzzles. Time to sit back and watch/make
the magic happen. It is recommended to have open the progress, queue, chat and
the magic happen. It is recommended to have the progress, queue, chat and
hints pages open.

With version 4.0, puzzles should now automatically release at the set hunt start
Expand All @@ -282,7 +279,7 @@ like telling them) that they can view their room assignments by clicking "View
Registration" link on the front page.

**What if I find a typo or other issue with a puzzle?**: Simply fix the puzzle,
make sure the new version is uploaded to dropbox and click the download button
make sure the new version is uploaded to Dropbox and click the download button
for that puzzle from the management page.

**What if I accidentally unlock a puzzle for a team I shouldn't have?:** You can
Expand Down

0 comments on commit 5931f43

Please sign in to comment.