Auronet 4 - Specification Document

From Auroville Wiki
Revision as of 12:13, 5 August 2009 by Manoj (talk | contribs)
Jump to navigation Jump to search

This is a technical document meant for software developers. Edit it only if you know clearly what you are doing.

If you have general ideas please post it in AVnet 4     
Click through mock up is available here: http://www.bardo.in/avnet/

Users

  • Only people are allowed to register as a user.
  • Working Groups, Services, Communities etc are created as Groups (Refer Groups)
  • Every user will be belonging to one or more groups.
  • A user can register as a member of the site only by invitation
  • All RA Members can invite new people ( RA member or Non RA member ) to become a user.The invitation form should specify that only people not working groups or units etc can be invited to be a member and while sending invitation, the role of the member should be specified. ie. whether RA member or not.
  • Membership requires approval from the Site Administrator or Group Amdinistrator
  • All Non RA members requires a RA member as an invitee
  • It should be possible to see who has invited whom, in both invitee's profile as well as the profile of the invited.

Roles

Global Roles

  1. Site Administrator - Can do everything.
  2. Site Editor - view, create, edit, delete all content types, manage users.
  3. RA Member - ( Residents' Assembly Member - rights are within the groups where they are members.
    1. Can create group
    2. Can invite new people to Auronet who will be permitted within the groups where they have been invited if the groups is open to invitation.
  4. Non RA Member - Non Residents' Assembly Member - rights are within the groups where they are members. Refer Content Types.
  5. Un authenticated user - can see only the login page

Roles within Groups

There will be 4 roles by default available to all Groups; Their permissions are withing the Group where it is applied.

  1. Group Administrator - view, create, edit, delete all available content types within a group, manage users within a group.
  2. RA Member
    - Create, view, comment all available content types within a group
    - Edite, Delete own content.
    - Invite members
  3. Non RA Member
    - Create, view, comment - Articles ; Events - Survey - Voting - permission depends on each survey's permission settings.

Additional Roles can be added to a Group if required with specific access permissions.

Groups

All Residents' Assembly members can create groups.

  1. A group has its home page – url = www.auroville.org.in/name of the group
  2. Each group can have unique visual identity given by a header image and right column carried by all documents posted in that group
  3. Each group will have its unique categories to classify its nodes, this will be defined by the Group Administrator
  4. Groups be classified, example: Working Groups, Communities, Services, Farms, Schools etc
  5. There can be multiple Group Administratotors
  6. Minimum of one Group Admin should be a Residents Assembly member

Membership

By invitation or by request

  1. An invited member become a Group member by accepting invitation
  2. An unregistered user can receive invitation and become a member of the site as well as the Group that invited.
  3. Any user can request to be a member of a group if groups is open to subscriptions.
  4. Group Administrator has to approve membership
  5. Members of a Groups will be assigned Roles while becoming a Group member

Sharing

There are 5 levels to sharing a page in a group.

  1. Share with one or more Groups to: View or Comment
  2. Send as email to one or more people
  3. Share with world - send a copy of page to the public website www.auroville.org to: View

Important pages

This will be a block in the right column, an editable html area where group admin can post links to important nodes of the group.

Edit link will be available only to the group admins

Categories

  1. Each group can have its own unique categories (taxonomy) to list its nodes
  2. Group Admin can Add, edit or delete categories
  3. Group Admin can reorgansise nodes from one category to other.
  4. A node can belong to multiple categories
  5. The following content types will have categories to belong to.
    1. Events
    2. Articles and
    3. Surveys
  6. By default, the following categories will be available to all groups.
    1. Events
    2. Announcements
    3. Meeting Reports
    4. Discussions
    5. Surveys
    6. Files
  7. These categories may be renamed, removed or reordered by the Group Administrator or Site Administrator according to the needs of a specific group.
  8. Each category will indicate the number of nodes in that category.


Content Types

Events

Event calendar for with day, week and month views, this content type will be available in the groups and events can be shared or made public.

Every event will have:

  1. Title
  2. Location
  3. Category
  4. Time
  5. Description
  6. Author

Events are of 3 types

  1. Events that occur only on a given date and time; example: dance performance
  2. Events that last many days: example: a seminar / exhibition
  3. Events that are repeating; example: a weekly study class, yearly festivals, monthly workshops

There should be an option to print shedule of a week's events - this is for anyone to take a printout to put on notice boards. Description and Author information need not be captured in such print out.

In the login page there will be listed the 'Coming Events', this will be full node listing of coming events for 7 days.

In the home page 'Today's Events' will be listed as shown in the mock up model, with Week and Month option links, when there are no events for the day "No events today"

Events module home page will have full node linting of events for the coming seven days, i.e. Default view is 'Week', on the right column will be month grid with dates, selecting a date should list events for that date in the left side. Current date will be highlighted in the grid.

All the events that are over and more than 1 year old will be automatically deleted from the database.

Article

Article type will be available in all groups.

  • Article type will have Rivision feature to keep in record all changes happening to the document.
  • There should be a 'Diff' feature to locate the difference between two versions of a document.

Issue

Purpose of this module is to enable any registered member of AVnet to report issues to a Group and follow it up through threaded discussion. Technically an issue is a node with comments but with a specific access rights.

  1. Issue Tracker is a compulsory module for all Official Groups, for other groups it is an optional module.
  2. All registered users can post issues to any group, if a group has this module.
  3. Owner of an issue can view, edit, and delete an issue.
  4. Group members can only view an issue and comment on it.
  5. Group members can edit only their own comments.
  6. There should be option for email alert between issue owner and the group members when an issue is posted or comments are made.
  7. Group members can opt out from email alerts from the issue tracker.

Issue type will be availalbe only in the Working Groups - ( Working Groups are a set of groups with some specific features)

  • Any user who is not a member of a group can post an issue within a Working Group.
  • The issues posted by a user will be visible only to that user and the respective members of the group where it is posted.
  • Issues can be closed by any Working Group member.
  • A closed issue may be reopened by the author anytime.
  • There will be archives of all the issues.
  • Any visitor to a Working Group will be able to see how many issues are there unresolved and the total number of issues received in the last 30 days, but will not be able to see the issues themselves.

Survey

Webform module of Drupal Survey type will be available for all groups A survey can be restricted to the role 'Residents' Assembly' if necessary.

Petitions

Same as existing petitions module Petitions will be availalbe only in the group 'Auroville Community'

Directory

This is not a directory of Auronet registered users. It is a directory of Auroville telephone numbers and email ids maintained by the Telephone Department who will have the administrative rights to this content type.

Each entry will have the following:

  1. AV Name
  2. Community
  3. Phone
  4. Fax
  5. Cel
  6. Emai
  7. Masterlist Id - ?
  8. Auronet user Id - ?

Auronet users list will be listed in a similar manner in the diectory page, data will be pulled from Auronet user's profile data set.

An Auronet registered user can be mapped on to a directory entry, if there is a corresponding entry, and related data can be brought on to the user profile page. If an Auronet user has profile mapped on the the directory, the user should be able to edit that data and submit for the approval of the Dirctory administrator. In that case the submitted data will over write the existing one only after the aproval by the Directory administrator.

There should be option to export directory data as .csv file for importing into a spreadsheet; and this option should be available only the the administrator.

In addition, the Directory listing page will have on the right side - refer mock up model - a set of static links, displaying tabular contents of some static pages containing tel. numbers useful organisations, places etc. They will be categories into different pages that can be independently edited.

Blog

  1. Every registered use will get a blog - this is where they publish everything that is their personal stuff.
  2. Blog entry will be visible as per audience selected which depends on the groups a user is member of.

Bazaar

Online market place where users exchange goods and services. See existing Bazaar in the AV net - Usability requires improvement.

  1. Every ad will have
    1. Title
    2. Description
    3. Image
    4. Date posting
    5. Contact - name, email, phone
    6. Expiry date (default 1 month ahead, not for display, only to auto delete the posted item)
  2. Ads are grouped into categories
  3. Site Administrator creates categories
  4. Authors can edit their own content.

Quotes

  • A quote has author and the text
  • Quotes change every day i.e. stay for 24 hours changing at 00.00 hrs
  • There are two types of quotes
    • Quote specified to be displayed on a given date
    • Quotes that can be recycled
  • Quotes will be recycled only when there are no fresh quotes available in the database
  • Least recycled and the oldest quotes will be reused in order
  • This module will be displayed on the login page
  • Site Editor add/edit/delete quotes

Downloads

Downloads module similar to what is existing in AVnet

Pulse

Functionality similar to Advanced Poll module of Drupal http://drupal.org/project/advpoll
Pulse will be using this module to generate its questions.
Each poll can be resistricted within roles.

Notes to the programmer

Home page

Toy grey band

- right side links, all open in a new window

Logo band

  • Logo - link http://www.auroville.org.in
  • Home
  • About Auroville - Goes to a book first page, hierarchic nodes, editable by members of the group 'Auroville Website'
  • Groups - Goes to 
  • Public tab left column
    • Everything published in the groups and shared with the group Residents Assembl
    • Regardless of the individual who posted it, author name will not be shown in this column, only the name of the group will be shown as author