Content Management/User Documentation: Difference between revisions

From OLPC
Jump to navigation Jump to search
No edit summary
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== User Documentation ==

* User manual
** We will have a page on wiki for user manual.

* Help systems
** On all OLPC website webpages, there will be a link to user manual.

* Installation manuals

* Release notes
** List of features in final release.


= Documentation v1.0 =
= Documentation v1.0 =


Line 20: Line 6:
*The content will either load in your browser or you will be presented with a dialog to download depending on browser configuration
*The content will either load in your browser or you will be presented with a dialog to download depending on browser configuration


= Registering an Account =
= Submitting Content =
An account is required to submit content.
An account is not necessary to view or browse the content, only to submit.
*To register an account, select '''Register''' from the menu.
*To register an account, select '''Register''' from the menu.
*Enter required data, and press the create button.
*Enter required data, and press the create button.

= Submitting Content =
An account is required to submit content.
Select '''Submit''' from the menu.
Select '''Submit''' from the menu.
**Alternately, select '''Submit Translation''' or '''Submit New Version''' from a content page.
*Enter a brief, descriptive title.
*Enter a brief, descriptive title.
*Press '''Browse''' and select the file to submit on your computer.
*Press '''Browse''' and select the file to submit on your computer.
*In the '''Tags''' field, enter relevant keywords, space seperated.
*In the '''Tags''' field, enter relevant keywords, comma-separated.
*Select a category and language.
*Select a category and language.
*Press '''Submit'''
*Press '''Submit'''
*Confirm entry.
*Confirm entry.

= Searching =
To search, visit the '''Search''' link. Search supports ''and'', ''or'', and grouping via quotation marks.


= Administering Content =
= Administering Content =
Access /admin/
Access /admin/
Login using an account with administrative privileges.
Login using an account with administrative privileges.

Create/Read/Update/Delete as necessary.
Create/Read/Update/Delete as necessary.

= Installation =
*Ensure web server is running Python 2.5 and Django 0.96.
** Installation file for Python 2.5: http://www.python.org/download/
** Installation file for Django 0.96: http://www.djangoproject.com/download/
*Copy files to a web-accessible directory.
*Open '''settings.py'''
*Set the absolute path variable at the top of the file. This path determines where static media is stored, and where all content is saved.
*Change other settings as needed (optional)
*Access /admin/, add categories, admins as necessary

= Release Note =
*v1.0
*Overview: The OnLine Processing of Content system allows submission of content. Users can view all submitted content.
*Purpose: Initial release document.
*Features
**Submit
**View
**Search
**Administrate

[[Category:Content Management]]

Latest revision as of 03:31, 16 March 2008

Documentation v1.0

Viewing Content

  • From the main page, select a category. From the list presented, select either a subcategory or a piece content. Repeat as necessary.
  • After selecting a content item, you can view details and download the content.
  • The content will either load in your browser or you will be presented with a dialog to download depending on browser configuration

Registering an Account

An account is not necessary to view or browse the content, only to submit.

  • To register an account, select Register from the menu.
  • Enter required data, and press the create button.

Submitting Content

An account is required to submit content. Select Submit from the menu.

    • Alternately, select Submit Translation or Submit New Version from a content page.
  • Enter a brief, descriptive title.
  • Press Browse and select the file to submit on your computer.
  • In the Tags field, enter relevant keywords, comma-separated.
  • Select a category and language.
  • Press Submit
  • Confirm entry.

Searching

To search, visit the Search link. Search supports and, or, and grouping via quotation marks.

Administering Content

Access /admin/ Login using an account with administrative privileges.

Create/Read/Update/Delete as necessary.

Installation

  • Ensure web server is running Python 2.5 and Django 0.96.
  • Copy files to a web-accessible directory.
  • Open settings.py
  • Set the absolute path variable at the top of the file. This path determines where static media is stored, and where all content is saved.
  • Change other settings as needed (optional)
  • Access /admin/, add categories, admins as necessary

Release Note

  • v1.0
  • Overview: The OnLine Processing of Content system allows submission of content. Users can view all submitted content.
  • Purpose: Initial release document.
  • Features
    • Submit
    • View
    • Search
    • Administrate