Auronet 4 - Specification Document: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This is a technical document meant for software developers. Edit it only if you know clearly what you are doing. | 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|AVnet 4]] '''<br> | If you have general ideas please post it in '''[[AVnet 4|AVnet 4]] '''<br> Click through mock up is available here: http://www.bardo.in/avnet/ | ||
Click through mock up is available here: http://www.bardo.in/avnet/ | |||
== Users<br> == | == Users<br> == | ||
| Line 22: | Line 21: | ||
*Only by invitation | *Only by invitation | ||
*All Aurovilians can invite new people ( Mastlist or Non Masterlist ) to become a user. | *All Aurovilians can invite new people ( Mastlist or Non Masterlist ) to become a user. | ||
*Membership requires approval from the Site | *Membership requires approval from the Site Administrator or Group Amdinistrator | ||
*All Non Masterlist members requires a Masterlist member as an invitee | *All Non Masterlist members requires a Masterlist member as an invitee | ||
== Roles<br> == | === Roles<br> === | ||
=== Global Roles === | ==== Global Roles ==== | ||
#Site Administrator - Can do everything.<br> | #Site Administrator - Can do everything.<br> | ||
#Site Editor - view all posts, create posts, edit / delete all posts, manage all users<br> | #Site Editor - view all posts, create posts, edit / delete all posts, manage all users<br> | ||
# | #Residents Assembly Member - view all posts, create posts, edit / delete own posts and comments<br> | ||
#Non Residents Assembly Members - view all posts, create posts, edit / delete own posts and comments<br> | |||
#Un authenticated user - can see only the login page<br> | #Un authenticated user - can see only the login page<br> | ||
=== Roles within Groups === | ==== Roles within Groups ==== | ||
There will be 4 roles by default available to all Groups; a group may choose roles from these groups.Their permissions are withing the Group where it is applied.<br> | There will be 4 roles by default available to all Groups; a group may choose roles from these groups.Their permissions are withing the Group where it is applied.<br> | ||
| Line 80: | Line 80: | ||
=== Important pages === | === 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.<br> | 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.<br> | ||
Edit link will be available only to the group admins | Edit link will be available only to the group admins | ||
=== Categories === | === Categories === | ||
| Line 95: | Line 95: | ||
=== File sharing === | === File sharing === | ||
File sharing will be done by having a category called files in groups, and attaching files to nodes. | File sharing will be done by having a category called files in groups, and attaching files to nodes. | ||
Multiple files can be attached to nodes | Multiple files can be attached to nodes | ||
=== Mailing list === | |||
Purpose of mailing list is to enable each group to maintain multiple mailing lists. | |||
=== Issue Tracker === | === Issue Tracker === | ||
| Line 130: | Line 130: | ||
#Title | #Title | ||
#Location | #Location | ||
#Category | #Category | ||
#Time | #Time | ||
#Description | #Description | ||
| Line 141: | Line 141: | ||
#Events that are repeating; example: a weekly study class, yearly festivals, monthly workshops | #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. | 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 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" | 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. | 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. | All the events that are over and more than 1 year old will be automatically deleted from the database. | ||
=== Wiki === | |||
#Purpose of this module is to provide wiki pages that are editable by all the users of a group or community depending on their permission. | |||
#All users with appropriate permissions to a given wiki page can edit it. | |||
#All wiki pages will have revision history and diff feature | |||
#All wiki pages should have option to add into watch list so that changes can be tracked by email notification. | |||
=== Image Gallery === | === Image Gallery === | ||
| Line 176: | Line 176: | ||
#Cel | #Cel | ||
#Emai | #Emai | ||
#Masterlist Id - ?<br> | #Masterlist Id - ?<br> | ||
#Auronet user Id - ?<br> | #Auronet user Id - ?<br> | ||
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.<br> | 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.<br> | ||
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.<br> | 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.<br> | ||
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.<br> | 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.<br> | ||
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.<br> | 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.<br> | ||
=== Blog === | === Blog === | ||
| Line 244: | Line 244: | ||
*Site Editor add/edit/delete quotes | *Site Editor add/edit/delete quotes | ||
=== Petitions === | === Petitions === | ||
Same as existing petitions module | Same as existing petitions module | ||
=== Survey === | === Survey === | ||
Specs to be laid | Specs to be laid | ||
=== Pulse === | === Pulse === | ||
Voting module | Voting module | ||
=== Cross Links === | === Cross Links === | ||
| Line 267: | Line 267: | ||
*Site Editor add/edit/delete words | *Site Editor add/edit/delete words | ||
=== Bookmarks === | |||
*Each user should be able to book mark any page available to them for future reference. | |||
*They should be able to view, edit, reorganise or delete bookmarks. | |||
== Notes to the programmer<br> == | == Notes to the programmer<br> == | ||
| Line 276: | Line 276: | ||
=== Home page === | === Home page === | ||
==== Toy grey band ==== | ==== Toy grey band ==== | ||
- right side links, all open in a new window | - right side links, all open in a new window | ||
| Line 288: | Line 288: | ||
*TV - http://www.aurovilletv.org | *TV - http://www.aurovilletv.org | ||
Logo band | Logo band | ||
*Logo - link http://www.auroville.org.in | *Logo - link http://www.auroville.org.in | ||
*Home | *Home | ||
*About Auroville - Goes to a book first page, hierarchic nodes, editable by members of the group 'Auroville Website' | *About Auroville - Goes to a book first page, hierarchic nodes, editable by members of the group 'Auroville Website' | ||
*Groups - Goes to | *Groups - Goes to | ||
*'''Public tab left column ''' | *'''Public tab left column ''' | ||
**Everything published in the groups and shared with the group Residents Assembl | **Everything published in the groups and shared with the group Residents Assembl | ||
Revision as of 08:06, 30 July 2009
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)
- There are two types of users
- Masterlist Members
- Aurovilians - Masterlist members above 18
- Newcomers - Those who are in the process of getting listed Masterlist
- Ex Aurovilians - Those who were in the Masterlist, but now lives outside Auroville
- Aurovilians - Masterlist members above 18
- Non Masterlist members
- AVI members
- Friends
Membership
- Only by invitation
- All Aurovilians can invite new people ( Mastlist or Non Masterlist ) to become a user.
- Membership requires approval from the Site Administrator or Group Amdinistrator
- All Non Masterlist members requires a Masterlist member as an invitee
Roles
Global Roles
- Site Administrator - Can do everything.
- Site Editor - view all posts, create posts, edit / delete all posts, manage all users
- Residents Assembly Member - view all posts, create posts, edit / delete own posts and comments
- Non Residents Assembly Members - view all posts, create posts, edit / delete own posts and comments
- Un authenticated user - can see only the login page
Roles within Groups
There will be 4 roles by default available to all Groups; a group may choose roles from these groups.Their permissions are withing the Group where it is applied.
- Group Administrator - view all posts, create posts, edit / delete all posts, manage users
- Group Member - view all posts, create posts, edit / delete own posts and comments
- Group Guest - only view access
Additional Roles can be added to a Group if required with specific access permissions.
Groups
Enable users to create and manage their own 'groups'. Each group can have subscribers, and maintains a group home page where subscribers communicate amongst themselves.
- A group has its home page – url = www.auroville.org.in/name
- Each group can have unique visual identity given by a header image which is carried by all documents posted in that group
- Each group should be able to categories its contents
- Groups be classified
- Only an Aurovilian can start a group, who by default become Group Admin
- There can be multiple Group Admins
- Minimum of one Group Admin should be an Aurovilian
Membership
By invitation or by request
- An invited member become a Group member by accepting invitation
- An unregistered user can receive invitation and become a member of the site as well as the Group that invited.
- Any user can request to be a member of a group
- Group Administrator has to approve membership
- Members of all the Groups will be assigned Roles while becoming a Group member
Sharing
There are 5 levels to sharing a page in a group.
- Share with one or more Groups to: View or Comment
- Share with Residents Assembly to: View or Comment
- Share with all the registered users to: View or Comment
- Share with world - send a copy of page to the public website www.auroville.org to: View
- Send as email to one or more people
Group Modules
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
Purpose of this module is the create categories in which nodes can be posted and listed.
- Each group can have its own categories
- Group Admin can Add, edit or delete categories
- Group Admin can reorgansise nodes from one category to other.
- A node can belong to multiple categories
File sharing
File sharing will be done by having a category called files in groups, and attaching files to nodes.
Multiple files can be attached to nodes
Mailing list
Purpose of mailing list is to enable each group to maintain multiple mailing lists.
Issue Tracker
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.
- Issue Tracker is a compulsory module for all Official Groups, for other groups it is an optional module.
- All registered users can post issues to any group, if a group has this module.
- Owner of an issue can view, edit, and delete an issue.
- Group members can only view an issue and comment on it.
- Group members can edit only their own comments.
- There should be option for email alert between issue owner and the group members when an issue is posted or comments are made.
- Group members can opt out from email alerts from the issue tracker.
Newsletter
Purpose of this module is to publish Newsletters online and mass mail them.
- All registered users should be able to subscribe or unsubscribe selected newsletters.
- Mailing list can have email ids of unregistered members - added by the Group Administrator
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:
- Title
- Location
- Category
- Time
- Description
- Author
Events are of 3 types
- Events that occur only on a given date and time; example: dance performance
- Events that last many days: example: a seminar / exhibition
- 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.
Wiki
- Purpose of this module is to provide wiki pages that are editable by all the users of a group or community depending on their permission.
- All users with appropriate permissions to a given wiki page can edit it.
- All wiki pages will have revision history and diff feature
- All wiki pages should have option to add into watch list so that changes can be tracked by email notification.
Image Gallery
Poll
Global Modules
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:
- AV Name
- Community
- Phone
- Fax
- Cel
- Emai
- Masterlist Id - ?
- 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
- Every registered use will get a blog - this is where they publish everything that is their personal stuff.
- 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.
- Every ad will have
- Title
- Description
- Image
- Date posting
- Contact - name, email, phone
- Expiry date (default 1 month ahead, not for display, only to auto delete the posted item)
- Ads are grouped into categories
- Site Admin creates categories
Yellow pages
Yellow pages directory of goods and services useful to the community posted by the users.
- Ads will be grouped into categories
- Chief Admin can create categories
- Each category will show how many items are there in it
- User can choose to see only AV products and services or all
- Each category is link to the page of that category.
- Items can be sorted:
- Chronologically
- Top rated
- Most viewed
- Titles
- Author
- Number of categories are not limited
- A post has
- Title
- Description
- Contact – name, address, email, phone
- Users can rate every item in the yellow pages on a scale of 5 stars
- A user can any time modify rating given to an item
- There will be search feature exclusively for the yellow pages
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
Petitions
Same as existing petitions module
Survey
Specs to be laid
Pulse
Voting module
Cross Links
- Define words + url that will become hyperlinks through out the site automatically.
- Site Editor add/edit/delete words from the list.
- Word index view - as links - to site users for browsing
Word Filter
- Difine words that will be filtered out and replaced with stars site wide.
- Site Editor add/edit/delete words
Bookmarks
- Each user should be able to book mark any page available to them for future reference.
- They should be able to view, edit, reorganise or delete bookmarks.
Notes to the programmer
Home page
Toy grey band
- right side links, all open in a new window
- Email - http://mail.auroville.org.in
- Wiki - http://wiki.auroville.org.in
- .ORG - http://www.auroville.org.in
- .COM - http://www.auroville.com
- FS - http://fs.auroville.org.in
- RADIO - http://www.aurovilleradio.org
- TV - http://www.aurovilletv.org
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