Merge pull request #188 from ox-it/user-guide

Documentation / User guide
ox-it · Jan 9, 2015 · f250a31 · f250a31
2 parents c616ad9 + f3d7fd9
commit f250a31
Show file tree

Hide file tree

Showing 13 changed files with 156 additions and 11 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,21 +3,24 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to talks.ox's documentation!
-====================================
+############
+Oxford Talks
+############
 
-User documentation
-==================
+
+**********
+User Guide
+**********
 
 .. toctree::
     :glob:
 
     user/*
 
 
-
+******************
 Indices and tables
-==================
+******************
 
 * :ref:`genindex`
 * :ref:`modindex`

diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst
diff --git a/docs/source/user/talk-organisers.rst b/docs/source/user/talk-organisers.rst
@@ -0,0 +1,8 @@
+Talk Organisers
+===============
+
+.. toctree::
+   :maxdepth: 2
+
+   talk-organisers/create-a-series.rst
+   talk-organisers/add-a-talk.rst
diff --git a/docs/source/user/talk-organisers/add-a-talk.rst b/docs/source/user/talk-organisers/add-a-talk.rst
@@ -0,0 +1,91 @@
+Add a talk
+==========
+
+Title, time and date
+--------------------
+
+.. image:: images/add-a-talk/title--time-and-date.png
+   :alt: Title, time and date
+   :height: 306px
+   :width: 639px
+   :align: center
+
+
+#. Click **Add Talk** on the toolbar.
+#. If you don't yet know the title of the talk, tick the Title TBA box.
+#. You can assign the talk to a series (seminar series, conference etc) if you want.
+#. Set the date and time by clicking in the field and using the calendar picker. The date will display in Oxford format when you view the talk later.
+
+Speakers
+--------
+
+.. image:: images/add-a-talk/speakers.png
+   :alt: Speakers
+   :height: 246px
+   :width: 632px
+   :align: center
+
+
+#. If you start typing a speaker's name, you may find they are already in the system. If they aren't then, click **Create new person** to reveal the form to add a new speaker. 
+#. You may add as many speakers as you like.
+
+Venue
+-----
+
+.. image:: images/add-a-talk/venue.png
+   :alt: Venue
+   :height: 169px
+   :width: 647px
+   :align: center
+
+
+#. Start typing the name of a building or location and it should be found in the University's OxPoints system. The address and map information will be looked up automatically.
+#. Specific details - the room name or number, or information about how to gain entry - can be added in the box below.
+
+Abstract
+--------
+
+The talk abstract will be used for searching, so please add it if you have it. 
+
+The abstract field uses the Textile markup language - the basics are very easy to remember:
+
+**Headings**
+
+::
+
+     h1. Main Heading
+     h2. Sub heading
+
+**Paragraphs**
+
+::
+
+     Separate paragraphs with a blank line.
+     
+     This is a new paragraph.
+
+**Bullet Points and Numbered Lists**
+
+::
+
+     * First Item
+     * Second Item
+     # Item One
+     # Item Two
+
+**Links**
+
+::
+
+     "Link Title":http://www.ox.ac.uk
+
+If you need more, there is a comprehensive manual on `txstyle.org <http://txstyle.org>`_ .
+
+Topics
+------
+
+We use Topics to group talks into subject areas, so assigning one or more topics to your talk will mean that it will have a better chance of being discovered and readvertised by specialist communities.
+
+Start typing and you will be offered options from the `Library of Congress Subject Headings <http://id.loc.gov/authorities/subjects.html>`_. 
+
+Please start with broader topics first e.g.: 'Neuroscience' or 'Ancient History', and then add narrower topics in the specialist area of the talk e.g.: 'Molecular Neurobiology' or 'Naval Warfare'.
diff --git a/docs/source/user/talk-organisers/create-a-series.rst b/docs/source/user/talk-organisers/create-a-series.rst
@@ -0,0 +1,48 @@
+Create a series of talks
+========================
+
+A series of talks could be a Seminar Series, a Conference, a Workshop day or any other context within which talks take place.
+
+Start entering the details of your first talk
+---------------------------------------------
+
+.. image:: images/create-a-series/start-entering-the-details-of-your-first-talk.png
+   :alt: Start entering the details of your first talk
+   :height: 314px
+   :width: 674px
+   :align: center
+
+
+#. Click **Add Talk** on the toolbar.
+#. Tick the series box.
+#. Click the **New series** button.
+#. The Add new series form will pop up.
+
+Add the series details
+----------------------
+
+.. image:: images/create-a-series/add-the-series-details.png
+   :alt: Add the series details
+   :height: 446px
+   :width: 663px
+   :align: center
+
+
+#. Choose a Series type - options at the moment are Seminar Series or Conference.
+#. If you like, you can add a phrase describing the timing - the usual time the seminars take place or the dates of a conference.
+#. A web address is optional - make sure you begin the address with http:// or https://.
+#. Start typing the department name and then select it from the drop down list.
+
+Save and continue
+-----------------
+
+.. image:: images/create-a-series/save-and-continue.png
+   :alt: Save and continue
+   :height: 338px
+   :width: 636px
+   :align: center
+
+
+Once you click the **Save changes** button, you can continue adding your talk.
+
+Your series will be now be available in the drop down list for your next talk.
diff --git a/docs/source/user/talk-organisers/images/add-a-talk/speakers.png b/docs/source/user/talk-organisers/images/add-a-talk/speakers.png
diff --git a/docs/source/user/talk-organisers/images/add-a-talk/title--time-and-date.png b/docs/source/user/talk-organisers/images/add-a-talk/title--time-and-date.png
diff --git a/docs/source/user/talk-organisers/images/add-a-talk/venue.png b/docs/source/user/talk-organisers/images/add-a-talk/venue.png
diff --git a/...talk-organisers/images/create-a-series/a14be2fb-80ec-4ac3-ad5e-2f59c2217461.png b/...talk-organisers/images/create-a-series/a14be2fb-80ec-4ac3-ad5e-2f59c2217461.png
diff --git a/docs/source/user/talk-organisers/images/create-a-series/add-a-talk.png b/docs/source/user/talk-organisers/images/create-a-series/add-a-talk.png
diff --git a/docs/source/user/talk-organisers/images/create-a-series/add-the-series-details.png b/docs/source/user/talk-organisers/images/create-a-series/add-the-series-details.png
diff --git a/docs/source/user/talk-organisers/images/create-a-series/save-and-continue.png b/docs/source/user/talk-organisers/images/create-a-series/save-and-continue.png
diff --git a/...nisers/images/create-a-series/start-entering-the-details-of-your-first-talk.png b/...nisers/images/create-a-series/start-entering-the-details-of-your-first-talk.png