Glossary project for DAW team

Project number:	2017
Opened by:	jsheu
Opened on:	星期四, 十月 27, 2011 - 11:24上午
Last modified:	星期二, 十二月 18, 2012 - 11:41上午
Operations:	add Case \| view all project cases

This Glossary project is initiated by the DAW team. Currently, there is a TIS (Translation Information System, http://tis.us.tzuchi.org/english/) that provides a simple-to-use interface as people want to translate Tzu Chi Chinese words into proper English words. The system can be thought as an official dictionary that offers references for all translators at Tzu Chi who want to translate Chinese words and phrases into English.

Currently, the TIS is run with backend of MS Access and frontend of PHP codes. The initial thinking is to utilize Drupal framework which already covers frontends and backends. And we just have to build a scheme to do bulk export/import from existing MS Access database later.

Project kickoff: 10/27/2011
Project members: Sister Louisa, Sister Peggy, Brother Keng, Brother James, Brother Jason
Document, DAW Glossary Schema: provided by Sister Louisa showing current MS Access schema, for reference
Document, function enhancement request: function enhancement to current TIS, for reference

Drupal seems to have some solutions to glossary.

Specifications

**Field Schema**
Field Name	Type	Required	View Permisison of Glossary Users	Access Field Migration	Note
Title	Drupal Title	Yes	Yes	Chinese (truncated to <255 characters, <127 Chinese characters)
Chinese	Marked-up texts	No	Yes	Chinese	Leave blank if the "Title" contents are not truncated
Meaning	Marked-up texts	No	Yes	Meaning
Preferred Translation	Marked-up texts	No	Yes	Preferred Translation
Other Translation	Marked-up texts	No	Yes	Other Translation
Category	Multiple select	Yes	No	Category: Buddhist terms Tzu Chi terms Medical terms Still Thoughts Sutra Phrases Regular Terms Chinese Idioms Tzu Chi Songs Da Ai TV Sutras Sutra Adaptation	11/27/2011: requested to add "Sutras" 12/5/2011: requested to add "Sutra Adaptation"
Source	Multiple select	Yes	No	Source: Way to Buddhahood Dictionary of Chinese Buddhist Terms, Soothill & Hodous Muller, Charles, ed. Digital Dictionary of Buddhism The Digital Dictionary of Buddhism Tzu Chi Hospital Glossary Jing Si Aphorisms Dharma As Water Buddhist Door Life Wisdom DAW Card SIM SIM Card Tzu Chi CD Water Repentance Book Misc	3/12/2012: requested to add "Tzu Chi CD" 12/5/2011: requested to add "SIM", "SIM Card", and "Water Repentance Book".
Reviewed	Yes / No	Yes	No	Reviewed: 0 => No -1 => Yes
Episode	Text (< 60 characters, < 30 Chinese characters)	No	No
Comments	Marked-up texts	No	Yes		replaced with Drupal comments?
Examples	Marked-up texts	No	Yes
Public term	Yes / No	Yes	Yes	Drupal-only field	12/15/2012: requested to add this field so that public terms can be generated http://glossary.tcnw.org/glossary/PublicGlossaryTerms, published page for public viewing. updated with certain frequency http://glossary.tcnw.org/glossary/publicTermReview, reviewing page used by the glossary team

Permissions

Permissions	Search / Read Glossary	Approve Glossary Entry	Add Glossary	Delete Glossary	Edit Glossary	Note
Glossary Reviewer User	X	X	X	X	X	login required
Glossary Content User	X		X		X	login required
Glossary General User	X					login required
Authenticated Users						general login'ed users
Anonymous Users						no need to login

Workflow

States: There are three states associated with each glossary entry.

States
Name	Meaning
Draft	This is the state when Glossary Content User creates initial glossary entries. Subsequent changes can be done by Glossary Content User with the state staying at "Draft". Contents are not published in this state.
Review	This is the state when the glossary entries are under the reviewing process by Glossary Review User. Contents are not published in this state.
Publish	Contents are reviewed and approved by Glossary Review User. Contents are published in this state.

State transitions: authorized user can initiate the state transition

State transitions
	Transition	Authorized user	Note
1	(creation) -> Draft	Glossary Content User, Glossary Review User	Initial content creation
2	Draft -> Draft	Glossary Content User, Glossary Review User	No state change. Users can keep modifying the contents.
3	Draft -> Review	Glossary Content User, Glossary Review User	The glossary entry is ready for the reviewing process.
4	Review -> Review	Glossary Content User, Glossary Review User	No state change. Users can keep modifying the contents.
5	Review -> Draft	Glossary Review User	The glossary entry is far from the quality.
6	Review -> Publish	Glossary Review User	The glossary entry is ready to publish.
7	Publish -> Review	Glossary Review User	The published glossary needs to be reviewed again.

Search interface
- need to customize the seach UI
Batch import/export
- need to export the complete data to portable files (e.g. Excel, CSV) so people can look for glossary while there is no Internet access.
- need to import current glossary from MS Access to Drupal. The module Migrate might be able to help here.
Expand to other languages
- Shall we consider to expand this Glossary system to other languages in the future?

Search Ranking

There are couple of sites talking about how the indexing and scoring is done in Drupal. This will help us to understand and to customize the searching algorithm for the Glossary Project.