Skip to content

Commit

Permalink
Merge branch 'master' of github.com:ox-it/talks.ox
Browse files Browse the repository at this point in the history
* 'master' of github.com:ox-it/talks.ox:
  renaming to talk-editors
  re-organization, most of Talk documentation done
  • Loading branch information
martinfilliau committed Jan 14, 2015
2 parents ba3bd6c + a8f2a84 commit 34e50e9
Show file tree
Hide file tree
Showing 28 changed files with 284 additions and 8 deletions.
12 changes: 12 additions & 0 deletions docs/source/user/talk-editors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Talk Editors
===============

.. toctree::
:maxdepth: 2

talk-editors/create-a-series.rst
talk-editors/create-a-talk.rst
talk-editors/formatting-the-abstract.rst
talk-editors/publicizing-your-talk.rst
talk-editors/prepare-and-publish.rst
talk-editors/share-editing.rst
104 changes: 104 additions & 0 deletions docs/source/user/talk-editors/create-a-talk.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
Create a talk
=============

Get started by creating a new talk.

The Add Talk form
-----------------

.. image:: images/create-a-talk/the-add-talk-form.png
:alt: The Add Talk form
:height: 154px
:width: 749px
:align: center


You can get to the Add Talk form by clicking **Add Talk** on the toolbar at the top of the screen.

Alternatively click Dashboard and then the **New Talk** button.

The Add Talk form is quite lengthy, but the most important fields are grouped at the top:

Title
-----

.. image:: images/create-a-talk/title.png
:alt: Title
:height: 176px
:width: 713px
:align: center


Get started immediately by typing the **Title**.

If you don't yet know the title you can leave the **Title** field blank and tick the **Title TBA** box.

For more information on scheduling talks before you have all the information see the :doc:`Prepare and publish <prepare-and-publish>` section of this guide.

Start and End
-------------

.. image:: images/create-a-talk/start-and-end.png
:alt: Start and End
:height: 334px
:width: 623px
:align: center


Clicking anywhere in the **Start** field will make the calendar picker appear.

Once you save the **Start **date and time, the **End** field will automatically be set to an hour later. You can change this by clicking in the End field.

Speakers
--------

.. image:: images/create-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.

You will find that **Talk organisers** and **Talk hosts** can be added in the same way. Scroll down to find these fields.

Venue
-----

.. image:: images/create-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 and displayed with the rest of the talk information.
#. Specific details - the room name or number, or information about how to gain entry - can be added in the box below.

You will find that the Organising department can be added in a similar way. Scroll down to find that field.

Saving
------

.. image:: images/create-a-talk/saving.png
:alt: Saving
:height: 73px
:width: 668px
:align: center


When you're ready, save the talk by clicking either:

* **Save and add another Talk** to go straight to a new Add Talk form
* **Done** to preview the talk you've just created

More Information
----------------

Now that you have run through the editing basics, look at the following sections for guidance on the other fields on the form:

* :doc:`Publicising your talk <publicizing-your-talk>` - explains how the **Abstract**, **Topic** and **Organising department** fields can help get your talk included in more listings
* :doc:`Formatting the abstract <formatting-the-abstract>` - provides a quick cheat sheet on how to add headings, lists and links to the **Abstract** field
* :doc:`Prepare and publish talks <prepare-and-publish>` - gives you tips and tricks on how to schedule talks before you have all the information available
41 changes: 41 additions & 0 deletions docs/source/user/talk-editors/formatting-the-abstract.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Formatting the Abstract
=======================

Keywords in the talk abstract will be used for searching, so please add the abstract if you have it.

Textile Markup
--------------

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>`_ .
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 76 additions & 0 deletions docs/source/user/talk-editors/prepare-and-publish.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
Prepare and publish talks
=========================

When you begin creating a talk it will be flagged as **In preparation**, you can switch the flag to **Published** when you are ready.

Switching a talk to Published
------------------------------

.. image:: images/prepare-and-publish/switching-a-talk-to-published-.png
:alt: Switching a talk to Published
:height: 107px
:width: 745px
:align: center


On the Talk Edit form scroll down to find the **Status** field and switch the radio button to **Published**.

You can switch back to **In preparation** at any time.

Scheduling talks before you have all the details
------------------------------------------------

.. image:: images/prepare-and-publish/scheduling-talks-before-you-have-all-the-details.png
:alt: Scheduling talks before you have all the details
:height: 338px
:width: 605px
:align: center


You can schedule and publish a talk even if you don't have all the details:

* You must supply the **Date** and **Time**
* Leave other fields on the form blank
* Use the **Title TBA** check box to leave the **Title** blank



Review incomplete talks
-----------------------

.. image:: images/prepare-and-publish/review-incomplete-talks.png
:alt: Review incomplete talks
:height: 157px
:width: 745px
:align: center


Click **Dashboard** in the tool bar at the top of the screen to view all your talks.

.. image:: images/prepare-and-publish/d575fec9-727b-488e-bc85-68e1ad17e075.png
:alt:
:height: 318px
:width: 706px
:align: center


#. Use the **Talk status** filter to show In preparation talks or...
#. Use the **Missing properties** filters to get the dashboard to show incomplete talks only - the filter will be highlighted when it is active.
#. To remove a filter click **All**

What does 'In preparation' mean?
--------------------------------

.. image:: images/prepare-and-publish/what-does--in-preparation--mean-.png
:alt: What does &apos;In preparation&apos; mean?
:height: 374px
:width: 741px
:align: center


A talk in preparation is:

* **Not Private** - all talks can be viewed if you know the web address
* **Can't be found** through the search interface or the lists on the Oxford Talks website
* Listed on your Dashboard
* Clearly marked as **In preparation**
43 changes: 43 additions & 0 deletions docs/source/user/talk-editors/publicizing-your-talk.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Publicising your talk
=====================

Oxford Talks will automatically compile listings of talks in subject areas and can pull together all talks belonging to a department or a division. The more information you can give about a talk, the wider it will be publicised.

Adding your talk to topic listings
----------------------------------

.. image:: images/publicizing-your-talk/adding-your-talk-to-topic-listings.png
:alt: Adding your talk to topic listings
:height: 163px
:width: 690px
:align: center


We use Topics to group talks into subject areas. 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.

Go to the **Topics** field on the Add talk form. Start typing and you will be offered options from the `Library of Congress Subject Headings <http://id.loc.gov/authorities/subjects.html>`_. Once you've found and selected a topic it will be highlighted in blue. To remove it, just click on the 'X'.

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'.

Adding your talk to department listings
---------------------------------------

.. image:: images/publicizing-your-talk/adding-your-talk-to-department-listings.png
:alt: Adding your talk to department listings
:height: 115px
:width: 755px
:align: center


We use the University's complete list of units, buildings and locations, Oxpoints, to specify the department or unit a talk belongs to.

Start typing the name in the **Organising department** field in either the Series or the Talk editing form.

Once you've assigned a department or unit to a Series it will be automatically assigned to any Talks you then add to the Series.

If you choose a sub-department or unit, then the talk will also appear in the parent department and division listings.

Public Lists [To Do]
--------------------

As well as topic and department listings, there may be some more ad hoc listings you would like your talk to be included in. In the next version of Oxford Talks, public lists can be created to collect together talks relevant to a particular theme, enterprise or project within the University - Athena Swan is a good example.
8 changes: 8 additions & 0 deletions docs/source/user/talk-editors/share-editing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Sharing Editing
===============

You can share the editing of a series or an individual talk with another Talk Editor

.. todo:: A screenshot of choosing an editor via email

Information on limitations etc
8 changes: 0 additions & 8 deletions docs/source/user/talk-organisers.rst

This file was deleted.

Binary file not shown.

0 comments on commit 34e50e9

Please sign in to comment.