Auronet 4 - Specification Document

From Auroville Wiki
Jump to: navigation, search

Please do not modify this document any more.

Thanks,

Manoj Pavitran

10th August 2009


Auronet 4 is the fourth generation intranet portal of Auroville.

Auronet 4 will focus on bring working groups online and help in organisational work in addition to being online commninity space of Auroville.

Click through mock up is available here: http://www.bardo.in/avnet/ The mock up code should not be used for building theme for the site, theme should be tableless CSS based cross browser compatible code. If there is any inconsistency between the mock up and this document, this document should be considered as final. The mock up model only shows some example pages showing general layout and some functionality. There will be some minor theme - skin, graphic - modifications without altering any functionality as given in this document. Auronet portal will be based on Drupal Open Source CMS To make sure migration to future versions of Drupal, the Drupal core shall not be modified.

Users

  1. Only people are allowed to register as a user.
  2. Working Groups, Services, Communities etc are created as Groups (Refer Groups)
  3. Every user will be belonging to one or more groups.
  4. A user can register as a member of the site only by invitation
  5. 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. Invitation also should specify to which group a user is invited.
  6. Membership requires approval from the Site Administrator
  7. All Non RA members requires a RA member as an invitee
  8. It should be possible to see who has invited whom, in both invitee's profile as well as the profile of the invited.

Global Roles

  1. Site Developer - Can do everything.
  2. Site Administrator - view, create, edit, delete all content types, manage users.
  3. RA Member - Members of Auroville's Residents' Assembly.
    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.
    3. Can view, create, edit, delete own content types available within groups depending on permissions within each group.
  4. Un authenticated user - can see only the login page

Roles within Groups

There will not be Roles within a group, instead Drupal's OG defaults will be used, ie. Groups Manager and Administrator.

OG Subgroup functionality may be used in the future if a group needs subgroups. However this feature need not be implemented in this version. Function reserved for the future.

Groups

Based on Drupal OG

  1. All users in the role RA Members can create groups.
  2. Each group can have unique visual identity given by a header image and a 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 are classified into cateogries (taxonomy), a group can belong to multiple categories
    1. Working Groups
    2. Services
    3. Schools & Educational Centres
    4. Art & Culture
    5. Planning & Architecture
    6. Health # Healing
    7. Farms
    8. Communities
    9. Economy & Business
    10. Design & Crafts
    11. Food & Recreation
    12. Study Groups
    13. Special Interest Groups
  5. There can be multiple Group Administratotors
  6. Minimum of one Group Administrator should be an RA member

Membership

Follow OG default options.

Sharing

  1. Follow OG default sharing - audiance, subscription options for content types available within a group.
  2. Article content type will have additional wiki option - see Arcticle content type details.
  3. OG default 'Public' option will not be available for all the groups. This option is reserved exclussively for Site Administrator, to send selected nodes to public site www.auroville.org
  4. Emailing a node - send link to a node or the entire content of the node to one or more email id's

About us

This will be a static content block in the right column, an editable html area where Group Administrator can post links. Edit link will be

available only to the Administrator.

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. These categories may be renamed, removed or reordered by the Group Administrator or Site Administrator according to the needs of a specific group. Each category will indicate the number of nodes in that category.
    1. Events
    2. Announcements
    3. Meeting Reports
    4. Discussions
    5. Surveys
    6. Files

Content Types

Events

  1. Event calendar with day, week and month views
  2. Event fields:
    1. Title
    2. Location
    3. Event type - predefined taxonomy terms common to all groups. Eg. Cinema, Dance, Theatre, Talk, Exhibition, Presentation, Workshop, Seminar, Class, Course
  3. Time
  4. Image - image will have a fixed position, max width 200 pix.
  5. Description
  6. Author
  7. Category - predefined taxonomy terms specific to each group in which an event is posted. Refer Group Category.
  8. 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
  9. 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.
  10. In the login page there will be listed the 'Coming Events', this will be full node listing of coming events for 7 days.
  11. In the home page 'Today's Events' will be listed as shown in the mock up model, with Week and Month option links
    1. when there are no events for the day say "No events today"
  12. 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.
  13. All the events that are over and more than 1 year old will be automatically deleted from the database.

Article

  1. Article type will be available in all groups.
  2. Article fields:
    1. Category - predefined taxonomy terms specific to each group in which an event is posted. Refer Group Category.
    2. Title
    3. Tags - user defined taxonomy
    4. Description
    5. Attached Files - it should be possible to attach multiple files for download, showing file name, file size and description of files attached.
    6. Tick box to accept 'Rules of the Game'
  3. An article node can be made into a Wiki page (editable by those who have access to it) on per node basis. Ideally this has to be done without modifying OG core module, if not possible consider using an additional content type dedicated to behave as wiki page as it is in the OG module defaults. If wiki feature is available, it should be highighted in the page as "Wiki page' so that the user clearly knows that this page is open to editing.
  4. Readers can comment on articles, comments will be threaded, threading format is shown in the mock up model
    1. When reply button is clicked for an existing comment, the data entry field should open right there below the comment to which the reply isto be made.
  5. Article type will have Rivision feature to keep in record all changes happening to the document.
    1. There should be a 'Diff' feature to locate the difference between two versions of a document.
  6. There should be access count showing homany uniqe users have accessed an Article node.

Issue

Purpose of this module is to enable any registered member of Auronet 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 content type available for all Working Groups, ( Working Groups are a set of groups with some specific features) for other groups it is an optional.
  2. All registered users can post issues to any group who has Issue Tracker
  3. The issues posted by a user will be visible only to that user and the respective members of the group where it is posted.
  4. Owner of an issue can view, edit, and delete an issue.
  5. Group members can view an issue and comment on it, they can edit or delete their 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.
  8. Issue can be closed by Group members who can post comments similar to Articles.
    1. A closed issue may be reopened by the author anytime.
    2. There will be archives of all the closed issues.
  9. 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.
  10. Issue fields:
    1. Title
    2. Tags - user defined taxonomy
    3. Description
    4. Attached Files - it should be possible to attach multiple files for download, showing file name, file size and description of files attached.
    5. Date

Survey

Webform module of Drupal - http://drupal.org/project/webform

  1. Survey type will be available for all groups, with audience targetting.

Petitions

  1. Petitions will be availalbe only in the group 'Auroville Community', with OG audience targetting.
  2. Any member of the group can initiate a petition, author can also delete the petition
  3. Petition will be addressed to one of the groups of Auronet
  4. Fields are:
    1. Adressed to: Group selection list.
    2. Title
    3. Summary
    4. Description
    5. End date
    6. Post date
  5. Users can sign up one of the options
    1. I support
    2. I do not support
  6. A user may change signature option any time till the petition is closed
  7. Petitions will have comments similar to Article comments
  8. The group to which a petion is addressed will have an alert linking to the petition
  9. A petition can be emailed with all its contents and signatures

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.

  1. Directory fields
    1. AV Name
    2. Community
    3. Phone
    4. Fax
    5. Cell
    6. Email
    7. Masterlist Id - not visible
    8. Auronet user Id - not visible
  2. Auronet users list will be listed in a similar manner in the directory page, data will be pulled from Auronet user's profile data set.
  3. 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.
    1. 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.
  4. There should be option to export directory data as .csv file for importing into a spreadsheet; and this option should be available only the Administrator of this content type.
  5. 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 user will get a blog - this is where they publish everything that is their personal stuff.
  2. Blog can have threaded comments similar to Article comments
    1. User can choose per node whether to allow comment or not.
  3. Blog entry will be visible as per audience selected and this depends on the groups a user is member of
  4. Blog fields:
    1. Title
    2. Categories - Every user can have their own uniqe categories (taxonomy) to group their nodes. Categories will be listed as 'Categories' on the right column with most used ones on the top, each one showing the number of nodes in it.
    3. Description
  5. There should be access count showing homany uniqe users have accessed a blog entry

Bazaar

Online market place where users exchange goods and services.

  1. Bazaar fields:
    1. Category
    2. Title
    3. Description
    4. Image - image will have a fixed position, max width 200 pix.
    5. Contact - name, email, phone
    6. Expiry date (default 1 month ahead, not for display, only to auto delete the posted item)
    7. Date posting - author cannot edit this.
  2. Ads are grouped into categories
  3. Site Administrator creates categories
  4. Authors can edit their own content.

All registered users can post in the Bazaar, this content type will not have group association.

Quotes

  1. A quote has:
    1. Text
    2. Author
    3. Date of display - this is optional field, if a date is specified the quote will be displayed on that date.
  2. Quotes change every day i.e. stay for 24 hours changing at 00.00 hrs
  3. Quotes will be recycled only when there are no fresh quotes available in the database
  4. Least recycled and the oldest quotes will be reused in order
  5. Quotes will be displayed in the home page
  6. Site Administrator add/edit/delete quotes

Downloads

This module is to provide space for downloading software.

  1. Download fields:
    1. Category - predefined taxonomy terms Created by Site Administrator
    2. Title
    3. Description
    4. Files - multiple files can attached - Each file will have name, file size and description
  2. All registered usres can download any file
  3. There should be a download statistics

This content type will not have group association. Contents can be posted only by users with permission.

Pulse

Functionality similar to Advanced Poll module of Drupal http://drupal.org/project/advpoll

  1. Pulse will be using this module to generate its questions.
  2. Pulse content type is available only within 'Auroville Community' and 'Residents Assembly', with OG audience targetting
  3. Pulse will have threaded comments option.

Only Site Administrator can post a new poll.


About Auroville, References and Help

These are three books - nodes heirarchically organised

  1. These pages will have wiki feature, ie, reader can also edit the content, also track versions and diff.
  2. All registered users can edit these pages.

General details

Login page

Top grey band

Right side links, all open in a new window

  1. Email - http://mail.auroville.org.in
  2. Wiki - http://wiki.auroville.org.in
  3. .ORG - http://www.auroville.org.in
  4. .COM - http://www.auroville.com
  5. FS - http://fs.auroville.org.in
  6. RADIO - http://www.aurovilleradio.org
  7. TV - http://www.aurovilletv.org

Logo band

  1. Logo - link http://www.auroville.org.in

External link www.auroville.org, opening in a new window.

Image of the Day

Login page will have image of the day, displayed from a collection of images.

  1. Only width of the image is fixed, height is variable.
  2. Caption will be displayed over the image with a transparent background
  3. If necessary Site Administrator should be able to specify date for an image so that it comes on that date.

Weather Module

Weather module showing Pondicherry weather for the coming one week, shown in the home page.

Home page

Logo band

  1. Logo - link http://www.auroville.org.in
  2. Home
  3. About Auroville - Goes to a book first page, hierarchic nodes, with wiki feature.
  4. Groups - Goes to group listing page.
  5. Public tab left column
    1. Nodes published in other groups but shared with the group 'Auroville Community'
    2. 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
  6. Public tab right left column
    1. Everything published by the individual users directly in the group 'Auroville Community'
  7. Private tab left column
    1. Everything from the groups where the user is a member and private.
  8. Private tab right column
    1. Everything from other groups where the user is not a member but shared with one of the groups where the user is a member.

New Members

This is a listing in the home page, latest 4 members who joined Auronet.

  1. shows only photo, it will be a link to their profile, if no photo is given dummy will be used.
  2. While hovering the photo the user name should be shown over the image.
  3. This is an automated dynamic listing.

Clean URLs examples

  1. A group's home page will be : www.auroville.org.in/name-of-the-group
  2. A group's node will be www.auroville.org.in/name-of-the-group/xyz ; where xyz is the node id
  3. A blog: www.auroville.org.in/blog/username/xyz
  4. A bazaar entry: www.auroville.org.in/bazaar/xyz
  5. A petition: www.auroville.org.in/petitions/xyz

5 Star rating

Example: http://drupal.org/project/fivestar There should be 5star rating feature for the following content types.

  1. Article and related comments
  2. Blog and related comments
  3. Download

WYSIWYG HTML editor

The 'Description' fields of all content types and their related comment fields will have WYSIWYG HTML editor Example:http://www.bardo.in/avnet/july27/Publish1.html# The Editor will have the following options:

  1. Styles - predefined set of styles, including H2, H3 etc.
  2. Bold
  3. Bulletted list
  4. Numbered list
  5. Link
  6. Image - to facilitage inserting images from the local machine, image should be automatically size optimized for the web, with maximum width 500px.
  7. Table
  8. Code View

Tool Tips

There should be dynamic contextual tool tips for all data entery forms to help the user, example is shown in the mock up model publishing sequence. A tool tip need to appear only when the cursor moves over the input field and its related area.

Edit buttons

For the Site Administrator or Group Administrator to edit the contents 'Edit' buttons will be shown when they hover over the areas where they

have editing rights. Clicking on the button will open up a new layer on the top of the current page with light box effect. The following will have hidden edit button that shows up only when hovering.

  1. Home page
    1. Quotes
    2. Highlights
  2. Groups
    1. Group header image
    2. Group description
    3. Group alert messages
    4. Group links ( About us )
    5. Group categories
  3. Blog
    1. Blog categories
  4. Directory
    1. entries
    2. right column links

For the general node Edit / Delete / Revision etc links, see http://www.bardo.in/avnet/july27/Article.html This pattern can be used for all node types.

Publish buttons

In the home page 'Publish' button will be shown only while hovering over an area, this is applicable to the following.

  1. Public tab, both columns
  2. Events
  3. Pulse
  4. Survey
  5. Bazaar
  6. Downloads
  7. Petitions

In the respective home pages of these modules there will be static visible publish button.

Publishing Work Flow

  1. An article will have five statuses
    1. Draft stage - it is saved by the author to complete.
    2. Waiting for Approval - A completed article is submitted and is waiting for approval by the Group Administrator. Approval is required only if an article is targetting audience outside the group where it is getting posted. Within a group approval is not required. A group may decide not to have approval process at all, this should be possible on a per group basis.
    3. Reverted - Article has been reverted back to the author for modification - with an enclosed note from the Group Administrator.
    4. Rejected - Article has been rejected, with an enclosed note from the Group Administrator.
    5. Approved - The article goes visible to its target audience and an email alert goes to the author about approval. - Approved articles will not have status stamp, all other status will be indicated by a status seal/stamp as shown in the mock up model.

User Profile

Fields are:

  1. Username
  2. Full Name
  3. Community / Location
  4. Photo
  5. Phone
  6. Email
  7. About Myself
  8. My interests

From the user profile it should be possible to track the following:

  1. My Groups
  2. My Blog
  3. My Comments
  4. My Posts
  5. My invitation - only if applicable.

Contact Forms

Every registered user can be contacted by a contact form, the email id in the profile can be a link opening cotact form In the directory, email id's can made into links that open a contact form.

  1. all contact forms will have 'Send me a copy' option

Flagging Content

Similar to - http://drupal.org/project/flag

  1. Reders can flag an article, survey, petition or blog or their related comments if they find it inappropriate
  2. While flagging an article or comment they can specify why they flag it.
  3. Site Administrators and Group Administrators gets email alerts when someone flags an article or comment
  4. Site Administrators and Group Administrators should be able to see the list of users who flagged and their messages.

Rules of the game

A single static page having Rules of the game, editable by the Site Administrator only.

Red titles in the home page

All red titles will be links taking to respective module's main pages or listing pages.

Deleting entries

  1. A user should be able to withdraw their posting any time.
  2. A withdrawn entry will not be visible but will be retained in the database:
    1. This keeps the integrity of the database intact
    2. Data is still available for any kind of future research if exceptional circumstances demand that.
  3. In the space of the posting a message indicating that the entry has been withdrawn by the user on such and such date will be displayed.
  4. All the related replies will be retained so that no one will be able to remove entries of other people indirectly by withdrawing their own entries.
  5. Only a Site Administrator can delete entries permanantly from the database.
    1. There should be an email alert to the Site Administrator when a user withdraws his or her posting - including comments.

Google Analytics

  1. Google Analytics should be integrated to follow site usage.


The document is authored by Manoj Pavitran. Last modified on 10th of August 2009