Merge branch 'master' of https://github.com/ox-it/talks.ox

docs/source/conf.py

@@ -30,9 +30,12 @@
 # ones.
 extensions = [
     'sphinx.ext.todo',
-    'sphinxcontrib.httpdomain'
+    'sphinxcontrib.httpdomain',
+    'sphinx.ext.intersphinx',
 ]
 
+intersphinx_mapping = {'widget': ('http://talksox.readthedocs.org/projects/talksox-js-widget/en/latest/', None)} 
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/source/http_api/endpoints/search.rst

@@ -4,13 +4,13 @@ Retrieve Talks via Search
 
 .. http:get:: /talks/search
 
-    Search for events
+    Search for Talks
 
     **Example request**:
 
     .. sourcecode:: http
 
-		GET /api/events/search?from=today&topic=X HTTP/1.1
+		GET /api/talks/search?from=today&topic=X HTTP/1.1
 		Host: talks.ox.ac.uk
 		Accept: application/json
 
@@ -24,7 +24,7 @@ Retrieve Talks via Search
         {
             "_links": {
                 "self": {
-                    "href": "http://127.0.0.1:8000/api/talks/search?from=01/01/01"
+                    "href": "http://talks.ox.ac.uk/api/talks/search?from=01/01/01"
                 },
                 "next": null,
                 "prev": null
@@ -92,7 +92,7 @@ Retrieve Talks via Search
     :type venue: string
     :query organising_department: Search for talks whose organising department is the organisation specified by this oxpoints ID
     :type organising_department: string
-    :query speaker: Search for talks at which the specified person is a speaker. Supply the unique slug for the person e.g. 'james-bond'
+    :query speaker: Search for talks at which the specified person is a speaker. Supply the unique slug for the person e.g. 'd47e2458-af73-4bc1-bf04-3c275e1c1254'
     :type speaker: string
 
     The response can be either in XML or JSON dependent on the 'accept' header in the request.

docs/source/http_api/summary.rst

@@ -6,8 +6,10 @@ Formats: JSON, XML
 
 The API is able to return either XML or JSON, depending on the ‘Accept’ header in the request. By default a web browser will specify XML in the request. Note curl doesn’t specify any preference, so the API will respond with json.
 
-To ensure you get xml back then add an Accept header to your request::
+To ensure you get xml back, add an Accept header to your request::
 
    curl https://new.talks.ox.ac.uk/api/series/041a5cc6-d65a-4dec-967d-3adc5162cea3 -H "Accept: application/xml"
 
-TODO authentication on some endpoints
+For a more detailed example of the API in use, see the :ref:`JavaScript widget documentation <widget:widget-index>`.
+
+

docs/source/index.rst

@@ -17,7 +17,21 @@ User Guide
     :maxdepth: 2
     :glob:
 
-    user/*    
+    user/*   
+
+****************************
+Web Managers and Integrators
+****************************
+
+An example widget to get you started with embedding talks in your own webpages can be found here:
+
+`https://github.com/ox-it/talks.ox-js-widget <https://github.com/ox-it/talks.ox-js-widget>`_
+
+The widget uses JavaScript to write a table, list or calendar view of selected talks to an HTML page. You can specify the criteria to select the talks you want.
+
+* :ref:`Widget Documentation Overview <widget:widget-index>`
+* :ref:`Parameters Reference <widget:parameters>`
+
 
 ***********************
 Developer Documentation

docs/source/user/talk-editors.rst

@@ -15,5 +15,6 @@ Talk Editors
    talk-editors/people-details
    talk-editors/contact
    talk-editors/differences
+   talk-editors/organisers
 
 

docs/source/user/talk-editors/organisers.rst

@@ -0,0 +1,37 @@
+Talks Editors and Talk Organisers
+=================================
+
+Talk and Series Organisers
+--------------------------
+
+Organisers 
+
+* are involved in the practical organisation of a talk or a series of talks
+* are the main point of contact for enquiries about the event. 
+
+Organisers are added to Oxford Talks in the same way as speakers and hosts. If they don't appear in the drop down list as you type then you can use the Add Person button to add them quickly to the system.
+
+Very often organisers will also be the people who add information about the talk to Oxford Talks - if that's the case then they will also need to be signed up as a Talks Editor.  
+
+Talks Editors
+-------------
+
+Talks Editors 
+
+* have the rights to edit the information in Oxford Talks
+* must have an Oxford University Single Sign On account and have applied to be a Talks Editor
+* can create new series or talks
+* can be added as an editor to other talks and series.
+
+Once a Talks Editor has been signed up, you should be able to add them to the list of editors for a series or talk by typing their email address.
+
+Why the two roles?
+------------------
+
+The old Oxford Talks had just one role - the List Manager was the person who added and edited lists and talks and was also the point of contact for enquiries. Anyone could add or edit talks and lists. 
+
+When we designed the new system, feedback from administrators was that they would prefer editing and adding of talks to be restricted, so we created the Talks Editor role and put in the option to specify an organiser without having to go through the process of signing them up to be an Editor as well. 
+
+
+
+