reorganizing and adding General User Guide

ox-it · Sep 9, 2015 · 8066fee · 8066fee
1 parent 5771f2b
commit 8066fee
Show file tree

Hide file tree

Showing 73 changed files with 630 additions and 16 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,12 +13,32 @@ Oxford Talks
 User Guide
 **********
 
+New features arriving in the next few months
+
 .. toctree::
-    :maxdepth: 2
-    :glob:
+    :maxdepth: 1
+
+    user/talk-users
+
+*******************
+General Information
+*******************
+
+.. toctree::
+    :maxdepth: 1
+
+    user/general
+
+**************
+Editors' Guide
+**************
+
+.. toctree::
+    :maxdepth: 1
+
+    user/talk-editors
+
 
-    user/*   
-
 ****************************
 Web Managers and Integrators
 ****************************
@@ -49,4 +69,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
diff --git a/docs/source/user/general.rst b/docs/source/user/general.rst
@@ -0,0 +1,7 @@
+.. toctree::
+
+   general/log-in
+   general/terms
+   general/organisers
+   general/differences
+   general/contact
diff --git a/docs/source/user/talk-editors/contact.rst → docs/source/user/general/contact.rst b/docs/source/user/talk-editors/contact.rst → docs/source/user/general/contact.rst
diff --git a/.../source/user/talk-editors/differences.rst → docs/source/user/general/differences.rst b/.../source/user/talk-editors/differences.rst → docs/source/user/general/differences.rst
diff --git a/.../d1a11eac-3994-43ab-a04e-def878f18588.png → .../d1a11eac-3994-43ab-a04e-def878f18588.png b/.../d1a11eac-3994-43ab-a04e-def878f18588.png → .../d1a11eac-3994-43ab-a04e-def878f18588.png
diff --git a/...ser/talk-editors/images/log-in/log-in.png → ...rce/user/general/images/log-in/log-in.png b/...ser/talk-editors/images/log-in/log-in.png → ...rce/user/general/images/log-in/log-in.png
diff --git a/...er/talk-editors/images/log-in/log-out.png → ...ce/user/general/images/log-in/log-out.png b/...er/talk-editors/images/log-in/log-out.png → ...ce/user/general/images/log-in/log-out.png
diff --git a/docs/source/user/talk-editors/log-in.rst → docs/source/user/general/log-in.rst b/docs/source/user/talk-editors/log-in.rst → docs/source/user/general/log-in.rst
diff --git a/docs/source/user/talk-editors/organisers.rst → docs/source/user/general/organisers.rst b/docs/source/user/talk-editors/organisers.rst → docs/source/user/general/organisers.rst
diff --git a/docs/source/user/general/terms.rst b/docs/source/user/general/terms.rst
@@ -0,0 +1,3 @@
+****************
+Series and Lists
+****************
diff --git a/docs/source/user/talk-editors.rst b/docs/source/user/talk-editors.rst
@@ -1,20 +1,11 @@
-Talk Editors
-============
-
 .. toctree::
-   
+
    talk-editors/sign-up
-   talk-editors/log-in
    talk-editors/create-a-talk
    talk-editors/create-a-series
    talk-editors/editing
    talk-editors/formatting-the-abstract
    talk-editors/publicizing-your-talk
-   talk-editors/last-minute-changes   
+   talk-editors/last-minute-changes
    talk-editors/share-editing
    talk-editors/people-details
-   talk-editors/contact
-   talk-editors/differences
-   talk-editors/organisers
-
-
diff --git a/docs/source/user/talk-editors/shared-public-lists.rst b/docs/source/user/talk-editors/shared-public-lists.rst
@@ -0,0 +1,3 @@
+************
+Public Lists
+************
diff --git a/docs/source/user/talk-users.rst b/docs/source/user/talk-users.rst
@@ -0,0 +1,7 @@
+.. toctree::
+
+   talk-users/explore-talks
+   talk-users/make-a-list
+   talk-users/add-to-your-calendar
+   talk-users/feed-in-your-calendar
+   talk-users/email-reminders
diff --git a/docs/source/user/talk-users/add-to-your-calendar.rst b/docs/source/user/talk-users/add-to-your-calendar.rst
@@ -0,0 +1,116 @@
+Copy talks to your own calendar
+===============================
+
+You can put the details of any talk into your Nexus, Google or iCloud calendar. How this works depends on the browser and calendar you are using; we've covered some of the standard combinations here. The following steps will work for either a single talk or a series of talks.
+
+.. Note:: Using this method, if the talk information changes in any way, the information in your own calendar **won't update automatically**. You should always check Oxford Talks to make sure that the time or location hasn't changed since you added the talk to your calendar.
+
+Find the Add to Calendar link
+-----------------------------
+
+.. image:: images/add-to-your-calendar/find-the-add-to-calendar-link.png
+   :alt: Find the Add to Calendar link
+   :height: 222px
+   :width: 593px
+   :align: center
+
+
+* For a single talk, click on the **calendar icon** next to any talk
+
+.. image:: images/add-to-your-calendar/306f6c30-18aa-46b9-b32c-a4a1703b6d55.png
+   :alt: 
+   :height: 195px
+   :width: 614px
+   :align: center
+
+
+* For a series of talks, use the **Add to your calendar** button
+
+The next steps depend on which combination of browser and calendar you are using:
+
+Using Internet Explorer and Outlook (PC)
+----------------------------------------
+
+.. image:: images/add-to-your-calendar/using-internet-explorer-and-outlook--pc-.png
+   :alt: Using Internet Explorer and Outlook (PC)
+   :height: 168px
+   :width: 802px
+   :align: center
+
+
+* Clicking the calendar icon in Internet Explorer will open a window at the bottom of your browser
+* Click **Open**
+
+.. image:: images/add-to-your-calendar/a76b304c-99bd-41f3-a3a6-8e8196a54840.png
+   :alt: 
+   :height: 379px
+   :width: 600px
+   :align: center
+
+
+* The talk details open as an Outlook calendar item
+* Click **Save & Close** to add the talk to your calendar
+
+Using Safari and Calendar (Mac)
+-------------------------------
+
+.. image:: images/add-to-your-calendar/using-safari-and-calendar--mac-.png
+   :alt: Using Safari and Calendar (Mac)
+   :height: 308px
+   :width: 614px
+   :align: center
+
+
+* Clicking the calendar icon in Safari should open the Calendar app automatically
+* You will be asked where you want to save your event - this can be your main Nexus calendar if you want
+* If you choose to add the talk to your Nexus calendar, you may get this message
+
+.. image:: images/add-to-your-calendar/dbfadfa7-5d03-4c94-b499-59a1d773259c.png
+   :alt: 
+   :height: 290px
+   :width: 567px
+   :align: center
+
+
+* Click OK and don't worry, this just refers to the link back to the original talk. It will be copied over to the event notes and will be clearly visible
+* Your talk(s) will be added to your chosen calendar
+
+Using Chrome and Google Calendar
+--------------------------------
+
+* Clicking on the calendar icon in Chrome will download a file to your computer - you can usually see this at the bottom of your browser.
+* The filename will be a list of numbers, letters and dashes ending in '.ics' e.g: 7545e0bc-b53c-4114-b3b7-fba953a08f74.ics
+
+.. image:: images/add-to-your-calendar/using-chrome-and-google-calendar.png
+   :alt: Using Chrome and Google Calendar
+   :height: 299px
+   :width: 614px
+   :align: center
+
+
+* In Google Calendar, choose **Import calendar** from the options for **Other calendars**
+
+.. image:: images/add-to-your-calendar/09b5c8b5-2f97-4050-99c4-93004870fab0.png
+   :alt: 
+   :height: 378px
+   :width: 614px
+   :align: center
+
+
+#. Browse for the file you've just downloaded
+#. Choose the calendar you want to import the file into
+#. Click import to add your talk(s) to your chosen calendar
+
+.. image:: images/add-to-your-calendar/b36986a4-a369-4e8b-a1a7-0f065b34c676.png
+   :alt: 
+   :height: 328px
+   :width: 588px
+   :align: center
+
+
+Further Information
+-------------------
+
+Subscribe to a continuously updated feed of events
+
+Set up reminders in your calendar
diff --git a/docs/source/user/talk-users/browse.rst b/docs/source/user/talk-users/browse.rst
@@ -0,0 +1,2 @@
+Browse Talks
+============
diff --git a/docs/source/user/talk-users/email-reminders.rst b/docs/source/user/talk-users/email-reminders.rst
@@ -0,0 +1,60 @@
+Set up email reminders
+======================
+
+Reminders and notifications by email are scheduled for the next phase of development. Meanwhile, there are a few limited options to set up email reminders using your own calendar.
+
+Google Calendar
+---------------
+
+You can set up a default email reminder for any calendar feed. This will apply to all the talks in the feed. (see the :doc:`Get an up-to-date feed <feed-in-your-calendar>` section for more information on calendar feeds) 
+
+* Click on the drop down list next to the calendar created by the feed
+* Choose **Edit notifications**
+
+.. image:: images/email-reminders/google-calendar.png
+   :alt: Google Calendar
+   :height: 380px
+   :width: 518px
+   :align: center
+
+
+* Adjust the **Event notifications** to notify you by Email 
+
+.. image:: images/email-reminders/d9ca8e6b-8080-4379-8e15-b5c8fff4447c.png
+   :alt: 
+   :height: 314px
+   :width: 614px
+   :align: center
+
+
+Calendar (Mac)
+--------------
+
+You can set up an email reminder for individual events *copied* into your **Nexus** calendar, but not for calendar feeds. (see the :doc:`Copy talks <add-to-your-calendar>` section for for information about copying talks)
+
+* Click on the date in an event display
+
+.. image:: images/email-reminders/calendar--mac-.png
+   :alt: Calendar (Mac)
+   :height: 260px
+   :width: 614px
+   :align: center
+
+
+* This will open up a panel to edit the date and other options
+* Choose *Custom* from the **alert** options list
+
+.. image:: images/email-reminders/07aa26d4-37fa-4498-8f48-e19246ead4ed.png
+   :alt: 
+   :height: 365px
+   :width: 337px
+   :align: center
+
+
+* Then choose *Email* in the pop-up box and set your email address and when you want to be reminded
+
+.. image:: images/email-reminders/2174bfe6-05cd-490c-b50b-2becb0e17499.png
+   :alt: 
+   :height: 261px
+   :width: 290px
+   :align: center
diff --git a/docs/source/user/talk-users/explore-talks.rst b/docs/source/user/talk-users/explore-talks.rst
@@ -0,0 +1,119 @@
+Explore Oxford Talks
+====================
+
+An introduction to Oxford Talks
+
+Browse and Search
+-----------------
+
+Today's talks are always displayed on the Home Page of Oxford Talks. To find out more about upcoming talks use the **Browse Talks** button or the **Search** box
+
+.. image:: images/explore-talks/browse-and-search.png
+   :alt: Browse and Search
+   :height: 117px
+   :width: 570px
+   :align: center
+
+
+View upcoming talks
+-------------------
+
+The Browse Talks page will show you all talks for the next 8 weeks. Use the date filters on the filter panel to adjust this.
+
+#. Click the calendar icon on the **Start Date** or **End Date** filters to set the date
+#. If you want to see all the upcoming talks, use the **clear** button on the **End Date** filter
+#. Click **Submit** at the bottom of the filter panel
+
+.. image:: images/explore-talks/view-upcoming-talks.png
+   :alt: View upcoming talks
+   :height: 463px
+   :width: 614px
+   :align: center
+
+
+See my department's talks
+-------------------------
+
+To see all upcoming talks happening in your department
+
+#. Start typing into the **Department** box on the filter panel. You don't need to type the full name (for instance, 'HI' will find the Faculty of History, acronyms like 'DPAG' will also work)
+#. Remember to click **Submit**
+
+.. image:: images/explore-talks/see-my-department-s-talks.png
+   :alt: See my department&apos;s talks
+   :height: 355px
+   :width: 617px
+   :align: center
+
+
+Find a seminar series
+---------------------
+
+If you are interested in a particular seminar series, or meetings of a society: 
+
+* Use the **Series** box in the filter panel if you know the name of the series you are interested in
+* Alternatively, browse the full list of series from the **View all** panel 
+
+.. image:: images/explore-talks/find-a-seminar-series.png
+   :alt: Find a seminar series
+   :height: 281px
+   :width: 463px
+   :align: center
+
+
+Discover talks on an interesting topic
+--------------------------------------
+
+It's also possible to find talks on a on a particular topic - you don't need to know the series talk belongs to or the organising department - there are two ways to do this:
+
+**Public Lists**
+
+* Click **Public Lists** in the **View all** panel to see collections of talks made by other people
+
+.. image:: images/explore-talks/discover-talks-on-an-interesting-topic.png
+   :alt: Discover talks on an interesting topic
+   :height: 317px
+   :width: 523px
+   :align: center
+
+
+**Topics**
+
+Talks Editors are also beginning to tag talks with a huge range of topics (based on the Library of Congress subject headings). Ways to browse talks by topic will be delivered in the next phases of development. 
+
+Meanwhile:
+
+* To find talks in a particular subject area use the **Search** box to type your search term
+
+.. image:: images/explore-talks/1eeac054-56b9-461b-81e7-a0299f31b32b.png
+   :alt: 
+   :height: 339px
+   :width: 552px
+   :align: center
+
+
+* All the topics assigned to a talk or series are clickable, so you can explore a topic further from an individual talk
+
+.. image:: images/explore-talks/204ed603-33b8-48b4-9ff3-c84675a70818.png
+   :alt: 
+   :height: 501px
+   :width: 487px
+   :align: center
+
+
+.. image:: images/explore-talks/88fe1021-88ef-4e74-8082-b0fa4e6684bd.png
+   :alt: 
+   :height: 286px
+   :width: 548px
+   :align: center
+
+
+Further Information
+-------------------
+
+Make your own collected list of talks
+
+Copy talks to your calendar
+
+Get a feed of talks in your calendar
+