Difference between revisions of "MuDoc system"

From CCE wiki archived
Jump to: navigation, search
(Definitions)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
short link to this page: http://bit.ly/mudocsys
 +
 +
= What is MuDoc? =
 +
'''MuDoc''' ('''Mu'''ltimedia/'''Mu'''sic '''Doc'''umentation) is a general-purpose digital repository designed to store and disseminate digital multimedia objects.  In particular, MuDoc was designed  to accommodate digitized ethnomusicological fieldwork, in order to address limitations inherent in traditional archives  (preservation, quality assurance, access, dissemination, rights management).
 +
 
= MuDoc Overview =
 
= MuDoc Overview =
'''MuDoc''' ('''Mu'''ltimedia/'''Mu'''sic '''Doc'''umentation) is a general-purpose digital repository designed to store and disseminate digital multimedia objects.  In particular, MuDoc was designed  to accommodate digitized ethnomusicological fieldwork, in order to address limitations inherent in traditional archives  (preservation, quality assurance, access, dissemination, rights management) by offering the following features:
+
MuDoc provides the following functionality:
  
 
* Federated database (distributed system with central brokerage hub).  Repositories can be located anywhere on the Internet; users see a single, seamless repository.
 
* Federated database (distributed system with central brokerage hub).  Repositories can be located anywhere on the Internet; users see a single, seamless repository.
Line 19: Line 24:
  
 
MuDoc's initial deployment (portal, brokerage, and repository) will reside on the [http://www.fwalive.ualberta.ca folkwaysAlive] server. When the system is fully tested and stable, other repositories will be able to join the federation as well.
 
MuDoc's initial deployment (portal, brokerage, and repository) will reside on the [http://www.fwalive.ualberta.ca folkwaysAlive] server. When the system is fully tested and stable, other repositories will be able to join the federation as well.
=[[MuDoc FAQ]] =
 
=[[MuDoc Help]] =
 
 
== Definitions ==
 
 
=== keywords ===
 
** graph: a set of nodes and links connecting them (mathematically, links are pairs of vertices) (in mathematical graph theory, nodes are called vertices, and links are called arcs)
 
** directed graph:  a graph in which links have direction (pointing 'from' the first node 'to' the second).  The starting node may be termed the "parent" of the ending node, its "child". (Mathematically, such links are 'ordered' pairs, comprising a first and second element.)
 
** acyclic directed graph:  a directed graph in which there are no loops (it is not possible, from any vertex,to  trace a continuous path, always moving from parent to child node, and return to the starting point.  In such a graph, every node (except the root node) has one or more parents, and may have one or more children as well. The acyclic condion implies that no node is an ascendant (or descendant) of itself. The root node has no parents.
 
** directed acyclic graph (dag):  acyclic directed graph
 
** directed tree:  an acyclic directed graph in which each node has one and only parent.  The folder hierarchy (disregarding "shortcuts") on your PC or Mac is an example of a directed tree.
 
** (MuDoc) keyword:  a textual word or phrase naming a node in a special dynamic dag called the "MuDoc Ontology" (see below). Each keyword represents a concept  with a  semantic extension in the world.  Thus a keyword is a tripartite structure:  text name; node; concept.  Because keywords occur within a dag, each keyword (except the root) has at least one parent, and may have children. 
 
** MuDoc Ontology: (a) the  directed acyclic graph of all keyword nodes.  MuDoc eywords  are arranged in a dag, with the following interpretation:if  keyword X is the parent of keyword Y then the extension of Y's concept is (asserted to be) a subset of the extension of X's concept. These assertions ought to be true, if the dag is to be usable. For instance, keyword "Africa" might be the parent of keyword "Cairo".  Keyword "Middle East" might also be a parent of keyword "Cairo".  (Keyword "Europe" could be set as parent of keyword "Cairo",  but this assertion is harder to justify.). Thus if X is a keyword, the following interpretions obtain:
 
*** X's parent:  a keyword whose concept includes that of X ("broader term")
 
*** X's child:  a keyword whose concept is subsumed within that of X ("narrower term")
 
** MuDoc Ontology: (b) the name of the root node of this graph (a better name would have been "MuDoc Ontology root").
 
 
=== assets and metadata ===
 
** asset:  a digital object of any sort, to which metadata, keywords, and digital rights can be attached
 
** metadata: asset attributes, each associated to fixed fields called metadata elements.
 
** metadata schema:  a set of metadata elements applied consistently to a set of digital objects. MuDoc is designed to support any number of metadata schemas.
 
** [http://dublincore.org/ Dublin Core]:  one particular metadata schema, designed for online interoperability.  At present, Dublin Core is the metadata schema provided in MuDoc.
 
 
=== roles ===
 
** user:  anyone registered to use the MuDoc system, defined by username, password, and profile.  A user may also be a reviewer or editor.
 
** reviewer:  a user assigned to review submissions falling under the semantic extension of particular keywords in the MuDoc Ontology.  Each reviewer is thus associated with one or more keywords for which he or she reviews.
 
** editor:  a user assigned to edit submissions falling under the semantic extension of particular keywords in the MuDoc Ontology. Each editor is associated with one or more keywords, for which he or she edits.  The editor for the root keyword ("MuDoc Ontology") is known as the Editor in Chief (EIC).
 
 
* submissions: there are in effect three kinds of user submissions: (1) asset submissions, structured as directed trees in which each node may be associated with an asset file, metadata, and keywords.  The asset submission's root node must have at least one associated keyword.  (2) keyword submissions.  Each such keyword is associated with existing keywords proposed as its new parents.  (3) role-requests (effectively self-submissions).  Here a user submits herself or himself to become reviewer or editor for a specific keyword.  Role-requests are presently not handled on the "submit" page, but they could be.)
 
 
* peer-review:  process by which submissions (including  role requests) are evaluated by an editor, in consultation with a set of reviewers.  In brief the process works as follows:  (1) user makes submission, associated with particular keyword(s); (2) MuDoc requests closest available editor to handle this submission; if this editor refuses or doesn't respond within a fixed time window, another selecction is made, until finally the request passes to the EIC, if necessary (the EIC cannot refuse requests); (3) the editor reviews the submission and requests a number of appropriate reviewers, who are also selected on the basis of keyword associations, in a process parallel to that of editor selection; (4) reviewers provide feedback; (5) editor makes final decision (accept, reject, or return with comments).
 
 
== General how-tos ==
 
 
* How to know navigate the system.  The MuDoc interface is divided into a number of pages:  "Login", "Home", "Request Role", "Profile", "Editor Review", "Review", "Search", "Search History", "Submit".  The name of the current page is always provided at the top of the screen, to the right of the MuDoc logo.  You always start at the "Login" page, and upon successful login are moved to "Home". From here you select the page corresponding to the action you wish to perform by clicking on the links appearing just below the MuDoc logo.  Select:
 
**  Home to handle messages in your inbox, request a role, or update your profile.  The Request Role page is at present only available via Home.
 
** Editor to perform the editor role
 
** Review to perform the reviewer role
 
** Search to locate assets, by keyword or metadata
 
** Search history to review search results
 
** Submit to submit new assets or keywords
 
** Logout to exist
 
 
* Searching and browsing the MuDoc Ontology. Searching and browsing the MuDoc Ontology is required  in several places (request role; search; submit), always using the same interface, comprising a writable text box, "find" button, and list of selected keywords.  Searching and browsing are integrated.  Selectable  keywords are displayed in dark blue, their parents and children in light blue.  Clicking "find" with no text in the text box renders the root node ("MuDoc Ontology") selectable  (this is admittedly not intuitive; a better way is coming soon).  Clicking "find" with any other text string in the text box searches for the string within the set of all keyword strings, and renders text matches selectable.  All displayed keywords are hyperlinks. Selectable keywords are displayed in dark blue, surrounded by parents (above) and children (below). Clicking a selectable (dark blue) keyword selects it, transferring it to the selected keywords list for further action (e.g. search, submit).  Clicking a non-selectable (light blue) keyword brings it into the "selectable" position, displaying a new set of parents and children.  Browse the dag by clicking on a parent or child keyword.
 
 
== Login page ==
 
 
** to login:  enter username and password, and click "submit" (note that passwords are sent clear at present, unprotected by https; do not use reuse important passwords )
 
** to register:  click "Not registered?" and follow the instructions.  Please enter your real name, as anonymity is not helpful except where enforced by peer review.  Enter an email you will actually read.  Set your availability, and enter a note of explanation below.
 
 
 
== Home page ==
 
 
 
===Inbox===
 
* click on a radio button to read the corresponding message
 
* respond by clicking "accept" or "decline" when appropriate
 
* click on inbox controls to view all messages, or page through messages
 
* click on inbox conrols to order messages by date, subject, or status ("closed" messages have been dealt with; "open" messages have not).
 
* if you've agreed to edit or review a submission, be sure to visit the editor or review pages next.
 
 
===User tasks===
 
* click on "request a role" to propose yourself as editor or reviewer for a particular keyword (see "request role page" below)
 
* click on "edit profile" to edit information you provided upon registration.  Please remember to keep your availability attribute up to date.
 
 
===Request role page===
 
# select role (editor or reviewer) from drop-down menu
 
# add statement: summarize qualifications, include a URL for your CV, etc.
 
# specify a keyword by browsing or searching the keyword ontology (you can only request one keyword at a time).
 
# submit request, or cancel to abort the operation
 
# your request will now pass through peer review (according to the keyword you selected); you will receive confirmation messages in your inbox.
 
 
== Editor page ==
 
# select tab corresponding to the editorial task you wish to perform
 
# click "refresh" to update the page
 
# select the asset, keyword, or role submission you wish to review by clicking on it (on the left)
 
# view details on the right
 
# follow steps 1-6 below (select reviewers, await feedback, issue final editorial decision).
 
 
== Review page ==
 
 
The procedure for reviewers closely parallels the procedure for editors; see "Editor page" for instructions.  The principal difference is that reviewers are only offering recommendations, and are not permitted to know the identity of the submitter except in the case of role-requests (in which case the submission is effectively the submitter).
 
 
== Search page ==
 
 
# select the tab corresponding to the search task you wish to perform.  Search by keyword allows you to search/browse the MuDoc Ontology, select a set of keywords, and execute a search (a boolean AND is implied). Keyword searches may be recursive or non-recursive.  A recursive search for keyword "Africa" implies a semantic (conceptual) interpretation of the keyword, and returns all assets marked with keyword "Africa" or marked with any keyword which is a descendant of "Africa" (and hence--according to the standard semantics of the keyword dag--whose real-world extension is a subset of the extension of "Africa").  A non-recursive sesarch for keyword "Africa" implies a syntactic interpretation of the keyword, returning only those assets actually marked with keyword "Africa" (but not returning, for instance, assets marked with "Ghana").  Note:  recursive search is coming soon.
 
# select keywords or metadata attribute/value pairs, as appropriate
 
# execute search
 
# click "view history" (or "Search History")
 
# click to view search results, including metadata and keywords, or delete them
 
# click on the title of a result to download the asset (if allowable)
 
 
Note that the search history is maintained across sessions as a permanent part of your user space; you can delete results which are no longer of interest.  Note that as the repository is dynamic, a search result may become outdated.
 
 
== Search History page ==
 
 
Search history has been explained above; see "Search page".
 
 
== Submit page ==
 
 
The submit page allows the user to submit assets and keywords; submission of roles is handled via the Home page. 
 
 
* Begin by  selecting the tab corresponding to your submission (asset or keyword). 
 
 
* Submit "Assets" tab
 
 
# select "Assets" tab
 
# click "Add" to add a new node (by default entitled "NEWITEM") to the asset hierarchy (displayed in tree form at the left).
 
# click this new node to select it. 
 
# enter information, asset, metadata, and keywords pertaining to this node using the form to the right. 
 
## Top section:  title, description, cultural, quality, authenticity.  These fields and drop-down selecdtions are  not technically metadata (they are  not searchable). The "title" field replaces "NEWITEM" to become the node name. 
 
## Top section digital rights controls: downloadable, price, visible.  These fields should be filled in whenever an asset is attached.  They are searchable as metadata.  Check "downloadable" to allow downloads.  Check "price" if you wish to charge a fee for downloads.  Check "visible" to make metadata visible, but prevent downloads (this section needs fixing).
 
# attach an asset if desired
 
# select a metadata model; at present only Dublin Core is available.
 
# add metadata attributes and fill in type (attribute) and value pairs.
 
# select keywords
 
# back at the top of the form, click "save" to save all information to the selected node. 
 
# click "Add" to add subnodes (recursively) and repeat the above process until the submission hierarchy is complete. Be sure to click "save" for each node or information you entered will be lost.
 
# select any node and click "Submit for review".  Note that you need not submit a "top level" directory node; you can submit any node.  If the submission contains no technical problems, it will disappear from the asset hierarchy. This means the submission has entered peer review.  Check your inbox for further information regarding the status of your submission.
 
 
* Submit "Keywords" tab
 
 
# select "Keywords" tab
 
# add nodes as described under "Submit Assets". Each node represents a keyword
 
# enter information and justification using the form to the right.
 
## keyword:  name your keyword
 
## reason:  justify the need for this keyword and its positioning within the Ontology
 
## select parent keywords.  Note that you can select more than one parent. However it is not possible to select children, i.e. you cannot position your new keyword within the existing ontology, but only at its edge.
 
## click "Save" to save your information
 
## select any node and clikc "Submit for review", as for assets.  If the submission contains no technical problems it will disappear from the keyword hierarchy and enter peer review.
 
 
 
  
 +
= See also =
 +
*[[MuDoc FAQ]]
 +
*[[MuDoc Help]]
 +
* [http://folkways.tapor.ualberta.ca/~michaelf/MuDocs_SRS_12.3.pdf MuDoc Functional Spec]
  
 
= Credits =
 
= Credits =
 
 
MuDoc was conceived by [mailto:michaelf@ualberta.ca Michael Frishkopf] in 2003, and designed by Michael Frishkopf and [mailto:dpd@ualberta.ca David Descheneau].  An initial prototype was completed by Ken Sobol in 2004, with  guidance from University of Alberta computer scientists Osmar Zaiane and Mario Nascimento.  Open source brokerage components ([[LIMBS]]) were contributed by [http://www.sun.com Sun Microsystems]. Implementation design, advisory services, and programming was provided by  Sun, [http://www.maketechnologies.com Make Technologies], [http://www.clrstream.com/ Clearstream], and Academic Information and Communication Technologies ([http://www.ualberta.ca/AICT AICT]) at the University of Alberta.   
 
MuDoc was conceived by [mailto:michaelf@ualberta.ca Michael Frishkopf] in 2003, and designed by Michael Frishkopf and [mailto:dpd@ualberta.ca David Descheneau].  An initial prototype was completed by Ken Sobol in 2004, with  guidance from University of Alberta computer scientists Osmar Zaiane and Mario Nascimento.  Open source brokerage components ([[LIMBS]]) were contributed by [http://www.sun.com Sun Microsystems]. Implementation design, advisory services, and programming was provided by  Sun, [http://www.maketechnologies.com Make Technologies], [http://www.clrstream.com/ Clearstream], and Academic Information and Communication Technologies ([http://www.ualberta.ca/AICT AICT]) at the University of Alberta.   
  
Line 161: Line 37:
  
 
MuDoc is one of many projects under development at [http://www.fwalive.ualberta.ca folkwaysAlive], under the auspices of the [http://www.fwalive.ualberta.ca Canadian Centre for Ethnomusicology], [http://www.uofaweb.ualberta.ca/music/ Department of Music], [http://www.arts.ualberta.ca Faculty of Arts], [http://www.ualberta.ca University of Alberta].
 
MuDoc is one of many projects under development at [http://www.fwalive.ualberta.ca folkwaysAlive], under the auspices of the [http://www.fwalive.ualberta.ca Canadian Centre for Ethnomusicology], [http://www.uofaweb.ualberta.ca/music/ Department of Music], [http://www.arts.ualberta.ca Faculty of Arts], [http://www.ualberta.ca University of Alberta].
 +
 +
= References and related resources =
 +
 +
[https://docs.google.com/presentation/d/1-2tR0a_qEXFZgjbunqiQoHRMUUjSPCOQ9SwBJ6mjZrk/edit?pli=1#slide=id.p13 The “Data” of Ethnomusicology Research: Recent Developments & Challenges], by Sean Luyk Music Librarian, Rutherford Library

Latest revision as of 16:18, 12 April 2015

short link to this page: http://bit.ly/mudocsys

What is MuDoc?

MuDoc (Multimedia/Music Documentation) is a general-purpose digital repository designed to store and disseminate digital multimedia objects. In particular, MuDoc was designed to accommodate digitized ethnomusicological fieldwork, in order to address limitations inherent in traditional archives (preservation, quality assurance, access, dissemination, rights management).

MuDoc Overview

MuDoc provides the following functionality:

  • Federated database (distributed system with central brokerage hub). Repositories can be located anywhere on the Internet; users see a single, seamless repository.
  • Web portal user interface, with permanent workspace and messaging system
  • Peer review system (providing a complete peer review workflow)
  • Non-hierarchical keyword ontology (supporting tagging, peer review, and search), mathematically structured as a directed acyclic graph of concepts.
  • Web submission and peer review of keywords
  • Web submission and peer review of multimedia content (e.g. audio, video, text, notation, image) hierarchically arranged using the standard nested "folder" paradigm.
  • Web submission and peer review of proposed peer review roles (users request editorial or reviewer roles for particular keywords; these requests are themselves peer reviewed)
  • Permanent storage and backup of accepted submissions
  • Tagging of submissions with keywords and metadata
  • Annotation: submitting objects to annotate other objects (including other annotations), enabling accumulation of scholarly knowledge
  • Linking submissions to existing repository objects
  • Searching by metadata or keyword (including recursive search through the ontology)
  • Browsing search results,
  • Rudimentary DRM (digital rights management), including e-commerce (designed to provide an income stream to artists around the world)
  • Downloading content (subject to DRM restrictions)

MuDoc's initial deployment (portal, brokerage, and repository) will reside on the folkwaysAlive server. When the system is fully tested and stable, other repositories will be able to join the federation as well.

See also

Credits

MuDoc was conceived by Michael Frishkopf in 2003, and designed by Michael Frishkopf and David Descheneau. An initial prototype was completed by Ken Sobol in 2004, with guidance from University of Alberta computer scientists Osmar Zaiane and Mario Nascimento. Open source brokerage components (LIMBS) were contributed by Sun Microsystems. Implementation design, advisory services, and programming was provided by Sun, Make Technologies, Clearstream, and Academic Information and Communication Technologies (AICT) at the University of Alberta.

Support for MuDoc has been generously provided by Western Economic Diversification Canada, Alberta's Ministry of Innovation and Science (now part of the Ministry of Advanced Education and Technology), Sun Microsystems, the Office of the VP (Research), University of Alberta, and the Faculty of Arts, University of Alberta.


MuDoc is one of many projects under development at folkwaysAlive, under the auspices of the Canadian Centre for Ethnomusicology, Department of Music, Faculty of Arts, University of Alberta.

References and related resources

The “Data” of Ethnomusicology Research: Recent Developments & Challenges, by Sean Luyk Music Librarian, Rutherford Library