Difference between revisions of "OPL3 Design Notes"
Jump to navigation
Jump to search
(Initial cut and paste) |
(Clean up and organize) |
||
| Line 1: | Line 1: | ||
| − | Announcements |
+ | ==Announcements== |
* Name change |
* Name change |
||
| Line 7: | Line 7: | ||
* Coding standards, validatation |
* Coding standards, validatation |
||
| − | Questions |
+ | ==Questions/ideas== |
* Language support - how to do? |
* Language support - how to do? |
||
| − | * |
+ | * Deployment |
| − | * |
+ | * Versioning - track WeBWorK versions? |
| − | * |
+ | * Acceptance Script - check syntax, formatting, metadata, variants |
| − | * |
+ | * Automatic testing - check that PG generate works for multiple seeds |
| − | + | * Bulk spell-check |
|
| − | * |
+ | * Automatic tagging (keyword extraction) |
| − | * |
+ | * What taxonomies, vocabularies - single or multiple, free or fixed... |
| − | * |
+ | * Workflow support |
| − | * |
+ | * Issue tracking |
| − | * Issue tracking |
||
| − | Additional metadata |
+ | ==Additional metadata== |
* GUID |
* GUID |
||
* Language |
* Language |
||
| Line 31: | Line 31: | ||
* original file path |
* original file path |
||
| − | + | ==Deployment== |
|
*Guiding principles |
*Guiding principles |
||
| − | * The arrangement of files within the OPL is independent of how problems and sets will display or |
||
| − | be organized in the problem-set editor/library browser. |
||
| − | * The principle goal of the directory structure in the OPL is to make it easy for individual |
||
| + | The arrangement of files within the OPL is independent of how problems and sets will display or |
||
| − | and institutional maintainers to maintain their collections of contributed files. The decision |
||
| + | be organized in the problem-set editor/library browser. |
||
| − | on whether to submit as an institution or individual should be based on whether responsibility for |
||
| − | the maintenance of the file belongs to the institution (file may be maintained by someone other |
||
| − | than the original contributor) or an individual. |
||
| − | * The file path will not be used as metadata. Metadata should be explicitly added to each problem |
||
| + | The principle goal of the directory structure in the OPL is to make it easy for individual |
||
| + | and institutional maintainers to maintain their collections of contributed files. The decision |
||
| + | on whether to submit as an institution or individual should be based on whether responsibility for |
||
| + | the maintenance of the file belongs to the institution (file may be maintained by someone other |
||
| + | than the original contributor) or an individual. |
||
| − | * The format and metadata for contributed files must comply with the WOPL community standards. |
||
| + | * The file path will not be used as metadata. Metadata should be explicitly added to each problem |
||
| − | * Problems and aggregations of problems should have an active maintainer. The WOPL community |
||
| + | * The format and metadata for contributed files must comply with the WOPL community standards. |
||
| − | will maintain files for which there is no current active maintainer. |
||
| − | * filenames will be represented in UTF8 to support diverse languages and applications |
||
| + | * Problems and aggregations of problems should have an active maintainer. The WOPL community |
||
| + | will maintain files for which there is no current active maintainer. |
||
| + | * filenames will be represented in UTF8 to support diverse languages and applications |
||
| + | |||
| + | ==Structure of the OPL== |
||
OPL |
OPL |
||
author-or-institution (edu.rochester.math, ca.ubc.math, djun.m.kim) |
author-or-institution (edu.rochester.math, ca.ubc.math, djun.m.kim) |
||
| Line 58: | Line 60: | ||
set (8.2, differentiation) |
set (8.2, differentiation) |
||
problem (8.2.15, composition-01) |
problem (8.2.15, composition-01) |
||
| − | problem-resources (pg file, flash, applet, images, . |
+ | problem-resources (pg file, flash, applet, images, .po files) |
Revision as of 16:24, 14 June 2012
Contents
Announcements
- Name change
- Move to git
- Metadata clean up, bug fixes
- Roadmap
- Coding standards, validatation
Questions/ideas
- Language support - how to do?
- Deployment
- Versioning - track WeBWorK versions?
- Acceptance Script - check syntax, formatting, metadata, variants
- Automatic testing - check that PG generate works for multiple seeds
- Bulk spell-check
- Automatic tagging (keyword extraction)
- What taxonomies, vocabularies - single or multiple, free or fixed...
- Workflow support
- Issue tracking
Additional metadata
* GUID * Language * Level (grade, year) * Difficulty * Book references * Learning Objectives * Variant * Subject classification * original file path
Deployment
- Guiding principles
The arrangement of files within the OPL is independent of how problems and sets will display or be organized in the problem-set editor/library browser.
The principle goal of the directory structure in the OPL is to make it easy for individual and institutional maintainers to maintain their collections of contributed files. The decision on whether to submit as an institution or individual should be based on whether responsibility for the maintenance of the file belongs to the institution (file may be maintained by someone other than the original contributor) or an individual.
- The file path will not be used as metadata. Metadata should be explicitly added to each problem
- The format and metadata for contributed files must comply with the WOPL community standards.
- Problems and aggregations of problems should have an active maintainer. The WOPL community
will maintain files for which there is no current active maintainer.
- filenames will be represented in UTF8 to support diverse languages and applications
Structure of the OPL
OPL
author-or-institution (edu.rochester.math, ca.ubc.math, djun.m.kim)
group (all, free-books, courses)
collection (challenge-problems, thomas-calculus, UBC-Math-110)
set (8.2, differentiation)
problem (8.2.15, composition-01)
problem-resources (pg file, flash, applet, images, .po files)
