Auronet 4 - Specification Document: Difference between revisions
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
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/ | 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/ | ||
#The mock up code should not be used for building theme for the site, theme should be tableless CSS based cross browser compatible code. | |||
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 == | == 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. Invitation also should specify to which group a user is invited. | |||
#Membership requires approval from the Site Administrator | |||
#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. | |||
== Global Roles == | |||
#Site Developer - Can do everything. | #Site Developer - Can do everything. | ||
| Line 26: | Line 33: | ||
#Un authenticated user - can see only the login page | #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. | 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 group needs subgroups. However this feature need not be implemented in this version. Function reserved for the future. | 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 == | == Groups == | ||
Based on Drupal OG | |||
#All users in the role RA Members can create groups. | #All users in the role RA Members can create groups. | ||
| Line 66: | Line 75: | ||
##Articles and | ##Articles and | ||
##Surveys | ##Surveys | ||
#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. | #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. | ||
##Events | ##Events | ||
##Announcements | ##Announcements | ||
| Line 72: | Line 81: | ||
##Discussions | ##Discussions | ||
##Surveys | ##Surveys | ||
##Files | ##Files | ||
#Each category will indicate the number of nodes in that category. | #Each category will indicate the number of nodes in that category. | ||
| Line 83: | Line 92: | ||
##Title | ##Title | ||
##Location | ##Location | ||
##Event type - predefined taxonomy terms common to all groups. Eg. Cinema, Dance, Theatre, Talk, Exhibition, Presentation, Workshop, Seminar, Class, Course | ##Event type - predefined taxonomy terms common to all groups. Eg. Cinema, Dance, Theatre, Talk, Exhibition, Presentation, Workshop, Seminar, Class, Course | ||
##Time | ##Time | ||
##Image - image will have a fixed position, max width 500 pix. | |||
##Description | ##Description | ||
##Author | ##Author | ||
##Category - predefined taxonomy terms specific to each group in which an event is posted. Refer Group Category. | ##Category - predefined taxonomy terms specific to each group in which an event is posted. Refer Group Category. | ||
#Events are of 3 types | #Events are of 3 types | ||
##Events that occur only on a given date and time; example: dance performance | ##Events that occur only on a given date and time; example: dance performance | ||
| Line 96: | Line 106: | ||
#In the home page 'Today's Events' will be listed as shown in the mock up model, with Week and Month option links | #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 say "No events today" | ##when there are no events for the day say "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. | ||
=== Article === | === Article === | ||
#Article type will be available in all groups. | #Article type will be available in all groups. | ||
#Article fields: | #Article fields: | ||
##Category - predefined taxonomy terms specific to each group in which an event is posted. Refer Group Category. | ##Category - predefined taxonomy terms specific to each group in which an event is posted. Refer Group Category. | ||
##Title | ##Title | ||
##Tags - user defined taxonomy | ##Tags - user defined taxonomy | ||
##Description | ##Description | ||
##Author | ##Attached Files - it should be possible to attach multiple files for download, showing file name, file size and description of files attached. | ||
##Date | ##Author | ||
#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. | ##Date | ||
#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. | |||
#Readers can comment on articles, comments will be threaded, threading format is shown in the mock up model | |||
##Article type will have Rivision feature to keep in record all changes happening to the document. | ##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. | ##There should be a 'Diff' feature to locate the difference between two versions of a document. | ||
| Line 115: | Line 133: | ||
=== Issue === | === Issue === | ||
Purpose of this module is to enable any registered member of | 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. | |||
#Issue Tracker is a | #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. | ||
#All registered users can post issues to any group | #All registered users can post issues to any group who has Issue Tracker | ||
#The issues posted by a user will be visible only to that user and the respective members of the group where it is posted. | |||
#Owner of an issue can view, edit, and delete an issue. | #Owner of an issue can view, edit, and delete an issue. | ||
#Group members can | #Group members can view an issue and comment on it, they can edit or delete their comments. | ||
#There should be option for email alert between issue owner and the group members when an issue is posted or comments are made. | #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. | #Group members can opt out from email alerts from the issue tracker. | ||
#Issue can be closed by Group members who can post comments similar to Articles. | |||
##A closed issue may be reopened by the author anytime. | |||
##There will be archives of all the closed 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. | |||
#Issue fields: | |||
##Title | |||
##Tags - user defined taxonomy | |||
##Description | |||
##Attached Files - it should be possible to attach multiple files for download, showing file name, file size and description of files attached. | |||
##Author | |||
##Date | |||
=== Survey === | |||
Webform module of Drupal | |||
#Survey type will be available for all groups, with audience targetting. | |||
=== Petitions === | |||
Same as existing petitions module | |||
#Petitions will be availalbe only in the group 'Auroville Community', with OG audience targetting. | |||
#Any member of the group can initiate a petition, author can also delete the petition. | |||
#Petition will be addressed to one of the groups of Auronet | |||
#Fields are: | |||
##Adressed to: Group selection list. | |||
##Title | |||
##Summary | |||
##Description | |||
##End date | |||
##Post date | |||
##Author | |||
#Petitions will have comments similar to Article comments | |||
#A user may change signature option any time till the petition is closed. | |||
#The group to which a petion is addressed will have an alert linking to the petition. | |||
#A petition can be emailed with all its contents and signatures | |||
=== Directory === | === 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. | 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. | ||
#Directory fields | |||
##AV Name | |||
##Community | |||
##Phone | |||
##Fax | |||
##Cell | |||
##Email | |||
##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 === | === Blog === | ||
#Every registered use will get a blog - this is where they publish everything that is their personal stuff. | #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. | #Blog can have threaded comments similar to Article comments | ||
##User can choose per node whether to allow comment or not. | |||
#Blog entry will be visible as per audience selected which depends on the groups a user is member of | |||
#Blog fields: | |||
##Title | |||
##Tags - tags will be listed as categories on the right column with most repeated tages on the top, each tag showing the number of nodes in it. | |||
##Description | |||
=== Bazaar === | === Bazaar === | ||
| Line 174: | Line 221: | ||
Online market place where users exchange goods and services. See existing Bazaar in the AV net - Usability requires improvement. | Online market place where users exchange goods and services. See existing Bazaar in the AV net - Usability requires improvement. | ||
# | #Bazaar fields: | ||
##Category | |||
##Title | ##Title | ||
##Description | ##Description | ||
##Image | ##Image - image will have a fixed position, max width 500 pix. | ||
##Contact - name, email, phone | ##Contact - name, email, phone | ||
##Expiry date (default 1 month ahead, not for display, only to auto delete the posted item) | ##Expiry date (default 1 month ahead, not for display, only to auto delete the posted item) | ||
#Ads are grouped into categories | ##Date posting - author cannot edit this. | ||
#Site Administrator creates categories | #Ads are grouped into categories - c | ||
#Site Administrator creates categories | |||
#Authors can edit their own content. | #Authors can edit their own content. | ||
=== Quotes === | === 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 | |||
#Quotes will be displayed in the home page | |||
#Site Administrator add/edit/delete quotes | |||
=== Downloads === | === Downloads === | ||
| Line 203: | Line 251: | ||
=== Pulse === | === Pulse === | ||
Functionality similar to Advanced Poll module of Drupal http://drupal.org/project/advpoll | Functionality similar to Advanced Poll module of Drupal http://drupal.org/project/advpoll | ||
#Pulse will be using this module to generate its questions. | |||
#Pulse content type is available only within 'Auroville Community' and 'Residents Assembly' | |||
== General details | == General details == | ||
=== Clean URLs === | === Clean URLs === | ||
| Line 220: | Line 271: | ||
==== Toy grey band ==== | ==== 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 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 | |||
[[Category:Information_Technology]] | [[Category:Information_Technology]] | ||
Revision as of 12:52, 6 August 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/
- The mock up code should not be used for building theme for the site, theme should be tableless CSS based cross browser compatible code.
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
- 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. Invitation also should specify to which group a user is invited.
- Membership requires approval from the Site Administrator
- 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.
Global Roles
- Site Developer - Can do everything.
- Site Administrator - view, create, edit, delete all content types, manage users.
- RA Member
- Can create group
- 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.
- Can view, create, edit, delete content types available within groups depending on permissions within each group.
- 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
- All users in the role RA Members can create groups.
- Each group can have unique visual identity given by a header image and a right column carried by all documents posted in that group.
- Each group will have its unique categories to classify its nodes, this will be defined by the Group Administrator
- Groups be classified, example: Working Groups, Communities, Services, Farms, Schools etc
- There can be multiple Group Administratotors
- Minimum of one Group Admin should be a Residents Assembly member
Membership
Follow OG default options.
Sharing
- Follow OG default sharing - audiance, subscription options for content types available within a group.
- Article content type will have additional wiki option - see Arcticle content type details.
- OG default 'Public' option will not be available for all the groups. This option is reserved exclussively for Site Managers, to send selected nodes to public site www.auroville.org
- 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
- Each group can have its own unique categories (taxonomy) to list its nodes
- 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
- The following content types will have categories to belong to.
- Events
- Articles and
- Surveys
- 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.
- Events
- Announcements
- Meeting Reports
- Discussions
- Surveys
- Files
- Each category will indicate the number of nodes in that category.
Content Types
Events
- Event calendar with day, week and month views
- Event fields:
- Title
- Location
- Event type - predefined taxonomy terms common to all groups. Eg. Cinema, Dance, Theatre, Talk, Exhibition, Presentation, Workshop, Seminar, Class, Course
- Time
- Image - image will have a fixed position, max width 500 pix.
- Description
- Author
- Category - predefined taxonomy terms specific to each group in which an event is posted. Refer Group Category.
- 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 say "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 fields:
- Category - predefined taxonomy terms specific to each group in which an event is posted. Refer Group Category.
- Title
- Tags - user defined taxonomy
- Description
- Attached Files - it should be possible to attach multiple files for download, showing file name, file size and description of files attached.
- Author
- Date
- 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.
- Readers can comment on articles, comments will be threaded, threading format is shown in the mock up model
- 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 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.
- 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.
- All registered users can post issues to any group who has Issue Tracker
- The issues posted by a user will be visible only to that user and the respective members of the group where it is posted.
- Owner of an issue can view, edit, and delete an issue.
- Group members can view an issue and comment on it, they can edit or delete their 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.
- Issue can be closed by Group members who can post comments similar to Articles.
- A closed issue may be reopened by the author anytime.
- There will be archives of all the closed 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.
- Issue fields:
- Title
- Tags - user defined taxonomy
- Description
- Attached Files - it should be possible to attach multiple files for download, showing file name, file size and description of files attached.
- Author
- Date
Survey
Webform module of Drupal
- Survey type will be available for all groups, with audience targetting.
Petitions
Same as existing petitions module
- Petitions will be availalbe only in the group 'Auroville Community', with OG audience targetting.
- Any member of the group can initiate a petition, author can also delete the petition.
- Petition will be addressed to one of the groups of Auronet
- Fields are:
- Adressed to: Group selection list.
- Title
- Summary
- Description
- End date
- Post date
- Author
- Petitions will have comments similar to Article comments
- A user may change signature option any time till the petition is closed.
- The group to which a petion is addressed will have an alert linking to the petition.
- 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.
- Directory fields
- AV Name
- Community
- Phone
- Fax
- Cell
- 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 can have threaded comments similar to Article comments
- User can choose per node whether to allow comment or not.
- Blog entry will be visible as per audience selected which depends on the groups a user is member of
- Blog fields:
- Title
- Tags - tags will be listed as categories on the right column with most repeated tages on the top, each tag showing the number of nodes in it.
- Description
Bazaar
Online market place where users exchange goods and services. See existing Bazaar in the AV net - Usability requires improvement.
- Bazaar fields:
- Category
- Title
- Description
- Image - image will have a fixed position, max width 500 pix.
- Contact - name, email, phone
- Expiry date (default 1 month ahead, not for display, only to auto delete the posted item)
- Date posting - author cannot edit this.
- Ads are grouped into categories - c
- Site Administrator creates categories
- 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
- Quotes will be displayed in the home page
- Site Administrator 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.
- Pulse content type is available only within 'Auroville Community' and 'Residents Assembly'
General details
Clean URLs
- A group's home page will be : www.auroville.org.in/name-of-the-group
- A group's node will be www.auroville.org.in/name-of-the-group/xyz where xyz is the node id
- A blog: www.auroville.org.in/blog/username/xyz
- A bazaar entry: www.auroville.org.in/bazaar/xyz
- A petition: www.auroville.org.in/petitions/xyz
- A blog: www.auroville.org.in/blog/username/xyz
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