Book of Tasks

This book contains a compendium of details about each tasks needed to be performed for testing the authoring tools and for discovering them. Each task is expected to be described precisely in text and may be complemented by screenshots, resulting resources, and screencasts.

We try to follow the following table of contents structure:

Comments about each task relevance and applicability are welcome.

Installation tasks (inst)

This book chapter will contains the following tasks:

Task inst-1: AM-local-installation: can see server running with example content

This task represents the first step into starting local usage of ActiveMath.

  • for now, uou need to follow installation instructions using ActiveMath-SVN
  • please make sure you are loading the ActiveMath Content examples
    • (part of HowToInstall)
    • if not: see page 2 of install book: copy-me
      • Unix command-line: link the content descriptor into conf
        • cd ~/activemath
        • cd conf
        • ln -s ../omdoc1/examplesSrc/ContentDescr\_Examples.properties
      • Windows and other GUIs: copy the content descriptor into conf
        • open the directory activemath then omdoc1 then exampleSrc
        • copy ContentDescr_Examples.properties to conf inside activemath
      • normally, you need to restart ActiveMath then since the configuration has changed

Task inst-2: first web-experience: can download picture and a language variant

This task is the first web-experience with ActiveMath local installation.

Prerequisites:

Tasks

  • find two different jpeg pictures
    • FIXME: provide two to download in case
  • copy them inside webapps/ActiveMath
  • rename them picture.jpg and picture_de.jpg
  • using your web-browser, go to picture.jpg
  • then go to picture.jpg?lang=de (you should see the second picture)
  • then go to picture.jpg?lang=fr (you should see the first picture)
  • then change your browser’s preferred language to be german (you should see the second picture with picture.jpg
  • you can then delete the two pictures

Task inst-3: checkout a collection and activate it

This task explains how to check-out a collection, LeAM_calculus, from a subversion repository and how to update it.

Prerequisite:

  • AM-local-installation
  • applications-on: ActiveMath, file-browser, web-browser
  • other requirements: good bandwidth, good machine (unless using a smaller content collection than LeAM_calculus).

Task steps

  • checking out the collection, we have several cases
    • it might be available as a single zipped archive in which case:
      • please download the zip archive
      • unpack it, it should contain a single directory, named after the collection
      • move that single directory into the content directory inside the activemath directory
    • it might be available under a subversion repository, as is the case of for LeAM_calculus collection, you need to check it out.
      • you should then have a collection URL, which is, in the case of LeAM_calculus, http://svn.activemath.org/LeAM-calculus/LeAM_calculus/
      • using the Unix command-line subversion client, you do so by cd-ing into the activemath directory and invoking cd content followed by svn co <theURL>, this may take some time
      • using tortoise SVN you navigate inside the file browser until the content directory inside the activemath directory then create a directory of the collections’ name (e.g. LeAM_calculus) then navigate to this new folder and right-click and invoke Tortoise SVN > Check-out, enter the appropriate URL, and check-out
    • it might be available from a LibreSource synchronizer project, as is the case of for the Komma collection, you need to check it out.
      • first create in the content directory an empty directory with the exact name of this collection (komma for the case above)
      • then go to the LibreSource synchronizer page and invoke the link create workspace
      • as base path, enter the path to the empty directory you just created
      • then, again from the synchronizer page, reload and invoke the UPDATE link
      • you should then have your directory ready
  • once the collection is checked-out it needs to be activated
    • please shutdown ActiveMath
    • if on a Unix system, cd to the activemath directory, invoke cd conf then, supposing this is LeAM_calculus, invoke ln -s ../content/LeAM_calculus/ContentDescr_LeAM_calculus.properties
    • if on another machine, or not wishing to use the command-line, copy the content-descriptor, i.e. the file stored in the root of the collection with a name starting with ContentDescr, into the directory conf inside the activemath directory
  • you may now start ActiveMath again. The index will be built with all the new content, this may take time, please let it happen until server’s console is not moving anymore
  • go to your browser, books of this content-collection should now be displayed in the main menu of ActiveMath
  • alternatively, you can search for it or browse collections

  • updating the collection only works if checked-out from a versioning server, we explain how to do so for a collection checked-out with subversion (or a zip file prepared for such)

    • if using the Unix command-line, simply cd to the directory of the collection (the directory inside the content folder bearing the name of the collection), then invoke svn update
    • if using TortoiseSVN, simply navigate with the file explorer until the directory of the collection, then right-click and invoke SVN update

Comments welcome!

Task inst-4: start jEditOQMath

This task is the first launch of the jEditOQMath authoring tool, using Java Web Start.

Prerequisites

Task steps

  • find the jEditOQMath web-page with google, you should find the jEditOQMath home
  • from there, find the link to the developer snapshot java-web-start
  • click it… let it download
  • answer yes to trust this certficate
  • answer yes to let it install
  • answer yes to the proposals of menus and file associations (jdk >1.5)
  • see splash screen
  • answer “ok” about the warning of the AntFarm plugin missing javac (FIXME this is a plague!!)
  • set the path to ActiveMath inside Plugins > Plugin-options then click “OQMath Jedit”, choosing the directory of ActiveMath, that is, the one that contains conf, lib, and thirdParty
  • now go to your desktop’s file browser (Finder on MacOSX, Windows Explorer on Windows, others on others…) and find your ActiveMath directory, inside there the omdoc1 directory, then the cd directory, you should find a file arith1.omdoc
  • double click arith1.omdoc, it should open in jEditOQMath, showing you an XML source of this file

Task inst-5: create-a-collection

This task describes the introduction of a first collection. This task needs fleshing.

Prerequisites

Task steps

  • invoke OQMath > Start a collection
  • give it a good name, it will be used often
  • let it run for a bit
  • restart ActiveMath
  • you should see Complete Recbook with the content of the collection you just started
  • click the link, you should see the book’s first page

Content Modifications and Previews (cont)

This chapter will contain the following task descriptions:

Task cont-1: Add first content and see it

The goal of this task is to perform a first content modification and see the content updated in one’s ActiveMath. This is half a sanity test.

Prerequisite

create-a-collection

Applications That Should be Running

jEditOQMath, ActiveMath, web-browser

Task description

  • go to jEditOQMath, in the file first.oqmath
  • find a CMP element, for example the hello-world axiom
  • inside this element, between and type a rare word or two (say, Möbius)
  • let us add a few a exotic characters as well: type the sequence of letters D e l t a followed by C-; (edit > expand-abbreviation). You should see a capital delta letter, a triangle.
  • save (press C-S or press the pencil toolbar-button)
  • validation happens, verify there’s nothing to complain about in the status bar (“XML parsing complete, 0 error(s)”).
    • if not, you have introduced illegal characters or at illegal places, undo a few times then re-insert without “<”, “&” and “>”.
  • open the AntFarm tab (the top tab on the left-side-bar of the jEdit window)
  • inside there, find an item called “fancy-surfaces collection, ActiveMath build file”
  • double click this item, or click it once then click the running man
    • (we are compiling and publishing, more about this in build-process)
  • see the operation happening in the “console”, ensure it says “build successful”
  • go to your browser, open / http://localhost:8080/
  • see your collection’s automatic book, open it, see your text and the Delta there
  • click the search link in the top tool menu
  • type one of the rare words.
  • see the title of the hello-world axiom, click it and see the same

Task cont-2: add-search-see: add an item, find it, see it

This task is about adding a new item, finding it in the search tools and previewing in different ways.

Prerequisite:

Task steps

  • go to jEditOQMath, in the file first.oqmath
  • place the cursor just before the line indicating </theory>
  • open the Templates Tree tab (see it on the left of the window, will replace AntFarm)
  • insert an axiom:
    • your selection should now be the id, put there my-first-axiom
  • press C-S-g (control-shift-G on Windows, command-shit-G on MacOSX)
    • (or click the find next button on the right of the toolbar, or invoke OQMath > Go to next template zone)
    • your selection should now be thte title, type my first axiom
  • remove the whole part between <extradata> and </extradata>
  • press C-S-g again
    • your selection should be the text, insert We have decided all graphs are trees
  • now save the file (C-S, pencil button, File > Save)
    • wait a bit to see if it indeed says XML parsing complete, 0 error(s)
    • if you have some errors, please open the “Error List” tab on the top and try to fix them
  • click the AntFarm tab on the left
  • select collection, ActiveMath Publishing build file
  • press the running man
  • wait till it says BUILD SUCCESSFUL (really do! using the browser aside may corrupt ActiveMath to the point that it needs to be restarted)
  • go to your browser
  • open the book Complete Recbook
  • see your axiom there
  • click the search tool (on the top list of tools)
  • type in decided lang:en
    • (you are searching for the word decided in english)
    • you should find your axiom
  • type in decided lang:fr
    • you should not find anything
  • request more display
  • request appears in
  • click the book it appears in

Task cont-3: new-OQMath-new-page: create a new document, see second page

This task is about adding a items in a new document, and seeing it appear in the automatically generated book.

Prerequisite:

Task steps

  • applications on: jEditOQMath, ActiveMath, web-browser
  • in jEditOQMath, having first.oqmath opened, invoke File > New (C-N)
  • activate the templates tab (on the left)
  • click (once) the new OMDoc or OQMath
  • save it right-away, let’s call it second.oqmath, it should be in the same directory as first.oqmath
    • syntax coloring should appear after having saved
  • now navigate between the template zones and complete the individual zones as good seems you
  • save the document (File > Save) and verify that XML parsing complete, 0 error(s) appears in the status bar, fix the errors otherwise
  • open the Ant-Farm tab on the left, and double click collection, ActiveMath Publishing build file
    • maybe ignore the errors for now
  • go to ActiveMath in the browser
  • simply do a reload of the page of the book, pressing the reload button of the browser
    • the second page should appear as a link in the table of contents, … and should be openable

Task cont-4: add a picture in OQMath, see it rendered

This task is about adding, within an item of an OQMath document, a picture and its declaration.

Prerequisite:

Task steps

TO BE COMPLETED

  • download a picture of your choice into the directory pics of the collection you created, name it appropriately. If unsure, download the picture the logo file and name it logo.jpg
  • open the file first.oqmath resulting of the collection creation
  • move your cursor into a space between <CMP> and </CMP> (and not between two dollar signs)
  • make sure the templates tab (on the left) is opened
  • click once Image Declaration to insert the <private/> element
  • insert id logo in the first template zone
  • correct the path before the next template zone from MinePics to mycollectionPics (if mycollection was the collection name (this path is a web-path, relative to the URL/ActiveMath2/main/book.cmd)
  • similarly change the mine to mycollection (or so) and put logo.jpg as file name.
  • the result should like:

      <private id="logo">
        <data format="html" href="../mycollectionPics/logo.jpg"/>
        <data format="pdf"  href="./content/mycollection/pics/logo.jpg"/>
      </private>
      <omlet argstr="logo" type="image" action="display">
          the activemath logo
      </omlet>
    
  • then invoke the template Image Use and fill the ID as logo and the caption to the appropriate text

  • now open the tab Ant Farm select the document _mycollection All Documents` then click the running man
  • make sure this process is terminated, saying “BUILD SUCCESSFUL”
  • go to the first page of the book we created
  • see the picture.

Comments and variations

  • we have put the picture declaration (the <private> element) at the same place as the <omlet/> element. It is possible to relax this and put the private anywhere else as long as it can be referenced

Task cont-5: create a table-of-contents in assembly tool, configure it, see it

The goal of this task is to create a table-of-contents, configure it in one’s own collection, and see it.

Prerequisite

Applications That Should be Running

jEditOQMath, ActiveMath, web-browser, assembly tool (started here)

Task description

  • go to ActiveMath with the web-browser
  • login as a user (registering if need be)
  • invoke the menu Tools > Assembly Tool
    • this will download a JNLP file which will start the application Assembly Tool first requesting your trust
    • you are now in front of a blank table-of-contents, free for you to edit
  • invoke _Edit > Add section _
  • now use your browser to go with ActiveMath to see some content from books
  • having found an item drag-and-drop the link of their title from the browser till the assembly tool within the section
    • repeat this for a few items
    • make sure that the items appear below the section you just created (you can double click them to view them)
  • the book can be seen within your books:
    • invoke File > upload book
    • go to the ActiveMath main menu
    • click the book with the title [Title]
  • the book can also be saved into your collection:
    • in the assembly tool, invoke _File > Save _
    • navigate to the directory oqmath you created in the new collection
    • name the file assembled-book.oqmath
      • saving them in oqmath directory and naming it with the suffix .oqmath ensures that this file is part of the sources
    • go to jEditOQMath, open the file assembled-book.oqmath
      • you obtain, after some time, a validation error indicating it cannot find the declaration of the element omd:omdoc, for a good reason, this file is without document-type hence cannot be validated
      • you can keep working with this file or, to make it more readable, invoke, OQMath > Clean up OMDoc
      • depending on the elements you dragged (any URLs can be dragged inside the assembly tool), you might obtain a few validation errors, removing the guilty elements is a way to live in peace, alternatively you ignore these errors (but… not the others!)
      • spot the first omgroup element, it will have an id attribute that is dynamically generated, adapt its value for you to remember it, e.g., assembled-book.
      • now open the collection’s content-descriptor (e.g. ContentDescr_my-collections.properties) which is in the directory containing the oqmath directory
      • find a few lines which start with RecBooks is, below them insert the following line: RecBooks.my-assembled-grouping.ID = mbase://<my-collection>/assembled-book having replaced <my-collection> with the identifier of your collection. If you are not sure it may be worth to use the searchable-item-list to check it before.
      • open the AntFarm tab on the left, select the build-file of your collection and press the running man
    • shut-down ActiveMath
    • recopy the content-descriptor into the conf directory inside ActiveMath (unless it was linked)
    • start ActiveMath
    • you should see your new recorded-book as any user (even anonymous)
    • note: the assembly tool can further edit the file assembled-book.oqmath (make it accept all files) but it will revert to namespace-full, using clean-up-omdoc again might be worth it.

Mathematical Formulae Related Tasks (ma)

The following tasks will be covered in this chapter:

Task ma-1: Input a formula and see it

This task describes the simple input of a polynomial within the formulæ, their preview in the web-browser, and the usage of their added value presentation

Prerequisite:

Task steps

  • open jEditOQMath and an OQMath file there, e.g. first.oqmath within the collection you now have
  • find a CMP element inside there, that is, find the place in the text right after <CMP> (maybe with a language attribute)
  • inside there, but not between two $ signs, we can now insert our expression, click to put the cursor
  • input $
  • input the formula, for example x^3+3/x^5+3x^2
  • close the math expression by inserting $ again
  • save your file (press the pen or invoke C-S)

  • click the AntFarm tab on the left

  • select collection, ActiveMath Publishing build file, press the running man, wait till it says `BUILD SUCCESSFUL
  • go to your web browser and there to your ActiveMath
  • open the book Complete Recbook
  • see the item you just enriched there
  • if you do not find it, redo the steps after doing the task cont-2

  • you can now hover with your mouse around this polynomial and let the sub-term and tooltips be shown

  • if you do not see the tooltips, you have probably been reported a reference error, that is, the symbols are not referenced explicitly enough
  • go back to jEditOQMath, find, towards the top of your file, the start of the theory element, put your cursor there right after it
  • invoke OQMath > Generate Imports, this will take a bit of time then will insert a few lines with suggested imports (and warnings for ambiguity)
  • now go back to your book page, see the polynomial with the tooltups

  • you can click on a sub-term, see the term popup and click Search for term (only using Mozilla family of browsers)

  • your item should appear as one of the results of the search, you may need to Generalize to all items, close the search tool
  • in ActiveMath book page, invoke Tools > Function Plotter
  • an applet pops-up with a graph pop-up

  • hovering back on your formula, click again to get the term-menu

  • invoke Drag term
  • a yellow box is drawn around the term, drag it into the window of the plotter applet, on the applet
  • the plotter should now display the graph of your function as well as the (reformulated) function

task ma-1: video of math input and enjoy

This video follows the task ma-1.

You can also download this video (8Mb), e.g., to provide to VLC.

Task ma-2: Create an OQMath notation for meter

This task describes the identification of an appropriate symbol and declaring its notations for input in QMath.

Prerequisite:

Task steps

  • we first need to find a symbol that satisfies our goals, a symbol that denotes meters for this we need to follow the (future) task identification-of-the-symbol which is not fully implemented, it’d be something such as

    • go in your web-browser, open the ActiveMath main menu, make sure you are logged-in as an author
    • open the search tool, enter the string id:metre (we search for items having an id containing the characters metre)
    • the first result should be a symbol with title metre (or an equivalent translated)
    • open this first result, get a little description, click the more link below
    • get the theory name, collection-name, and id-name
  • we now know that we wish to input OMS elements pointing to the symbol metre of the theory unitsmetric1_ of the collection openmath-cds (a rendering and more info can be seen in your ActiveMath, can be seen on the official demo or can be seen in the OpenMath website. Let us attach the input m when in QMath math-mode, to this symbol.

  • open, inside the oqmath directory, the file notations.qmath (this file is the center of all notations for QMath in the default collections)
  • add, at the very end of this file, the following line:

    Symbol: m SYMBOL "units_metric1:metre"

which will indicate to QMath that that letters m will be translated to<OMS cd="units_metric1" name="metre"/>. It also tells QMath that this symbol is not an operator to be applied somewhere.

  • let us type such into the item hello-world inside first.oqmath. Please open this file, find the item, then find, inside it, the closing-tag </CMP>
  • go to jEditOQMath, in the file first.oqmath
  • place the cursor just before the </CMP>
  • right before this insert the following lines:

    <br/>This is a metre: $m$

    <br/>This is two-and-a-half metres $2*m$ which is $2*x$ where $x$ is a meter.

  • save your file (press the pen or invoke C-S)

  • click the AntFarm tab on the left
  • select collection, ActiveMath Publishing build file
  • press the running man
  • wait till it says `BUILD SUCCESSFUL
  • go to your browser
  • open the book Complete Recbook
  • see your axiom there, find the last lines and see the two occurrences of m
  • please hover your mouse of the m, some occurrences show the right tooltip
  • please also note the fact that 2m shows without a dot whereas 2x does, this is an effect of the notations’ prototypes

Task ma-3: creating a symbol and writing a presentation-notation

This task describes the introduction of an angle symbol along with its input (QMath) notation as well as its presentation.

Prerequisite:

Task steps

  • let us first declare the symbol that interests us
    • use jEditOQMath, open first.oqmath and put your cursor right before </theory>
    • open, on the left, the tab Templates tree then click the Symbol template
    • we now fill the gaps (aka the template zones) for the symbol, give it the id angle
    • invoke Go to next template zone (CS-g), fill in the child-text of the CMP element which is the description of the symbol, e.g. This symbol has three arguments and returns the angle between the three points, centered at the middle point
    • invoke Go to next template zone, fill in the child-text of the commonname element, this will be the title and tooltip of this symbol, e.g. angle between three points
    • now first edit the notations.qmath file by adding the following line at the end then save notations. This will add a QMath notation for our symbol.

Symbol: angle APPLICATION 'my_first_theory:angle'

  • now we complement the presentation of this symbol, back into first.oqmath right after the </symbol> element

    • invoke CS-g again, enter the id of the symbolpresentation element, for example angle_pres
    • CS-g again, the for attribute is the target of our notations, the symbol id, i.e. angle, this will show as the underlying semantic of our presented symbol (e.g. as giving the text of the tooltip)
    • under the notation element, put two children, an OpenMath expression (or a QMath) and a MathML-p expression
    • the first template-zone is the QMath expression that is a typical notation. In our case, it would be $angle(A,B,C)$
    • the second template-zone is the MathML-expression for it. In this case, we need to enter simply a row of elements with the angle character as first, in MathML this is said as: <math><mrow><mo>∠</mo><mi>A</mi><mi>B</mi><mi>C</mi></mrow></math> (note the character between <mo> and </mo, it is the angle unicode character of number hex 2220.
    • now let us try to use this, copy and paste the following example using it after the </symbolpresentation> tag:

    <example id="angle_exp" for="angle"> <metadata><Title>Angle example</Title></metadata> <CMP> An example of angle is $angle(A,B,C)$. </CMP> </example>

  • save your file (press the pen or invoke C-S)

  • click the AntFarm tab on the left
  • select collection, ActiveMath Publishing build file
  • press the running man
  • wait till it says `BUILD SUCCESSFUL
  • go to your browser
  • open the book Complete Recbook
  • see the symbol element within the book as well as the example

Metadata Tasks and its Exploitation

Will contain the following descriptions:

Metadata Enrichment of an Exercise and See Mastery Bullets Update

This tasks explains how to enrich the trivial interactive exercise with metadata so that the successful result provokes a mastery boost indicated by the mastery-bullets.

Prerequisite:

Task steps

  • we continue based on add a trivial interactive exercise where the exercise mini-exo in the file first.oqmath was being edited
  • first verify that the for attribute of our exercise element is correctly written, e.g., that no Unresolved reference appears there
  • locate your cursor just below <metadata> and before </metadata> and add the <extradata> element
  • inside extradata type <, c, o, choose competency, tick self-closing, press return. Choose a value there, e.g. language
  • still inside extradata, type<,c,o, choosecompetencylevel, press return, in the dialog choose a value suchelementaryand tickself-closing-tag`
  • still inside extradata type <, d, i return. Choose difficult, tick self-closing tag
  • we have now added three essential pedagogical metadata which will serve for the learner-model to associate an exercise result with the mastery of a concept, the concept related to the exercise by the for relation
  • invoke a build in AntFarm (as in add a trivial interactive exercise](/?q=en/node/159)), correct any reported errors and re-run if need be
  • go to the book’s first page and click Start the exercise
  • enter any value in the blank
  • see Your exercise is over and close the window with the given button
  • this should trigger a reload of the book’s page and table-of-contents
  • the latter should now show a changed color aside of My first document (typically green, may depend on the competency and competencylevel you chose)

Interactive Exercise Tasks

The following tasks will be covered:

Add a static exercise

This tasks explains how to create a static exercise and see it.

Prerequisite:

Task steps

  • first insert the exercise header and metadata
    • type “<” then “e”, “x”, “e”, “r”, “c” then press return
    • add the id attribute as requested, e.g. mini-exercise
    • set the for attribute to the reference to a concept. If directly from the task create-a-collection, simply use hello-world
    • press return to finalize this tag
    • maybe right-away add the closing element: press return to go down one line, then press “<” and “/” which should input you the closing element. Saving is a good idea at this point.
    • inside the exercise element, add “<”, “m”, “e”, press space then “>”, then add a Title element (same procedure), then input a title, say A mini exercise.
    • close Title and metadata
  • we should now have reached something such as

      <exercise id="mini-exercise" for="hello-world">
        <metadata><Title>Mini-exercise</Title>
        </metadata>
    
    
      </exercise>
    
  • now go below metadata and add <CMP> followed by the exercise invitation, that is, the text that is presented to learners to invite them to start the first interactive exercise

    • inside CMP, type something such as Let us start a minimum exercise.
    • close the CMP
  • open the Ant Farm tab

  • select the build-file of your collection (by the name you gave when creating a collection)
  • double click it and throw a short look in the console pane that just opened below the editing pane
  • wait till it shows BUILD SUCCESSFUL
  • open the ActiveMath main menu with your browser (at http://localhost:8080/ActiveMath2/ typically)
  • open the book bearing your collection name
  • you should see the exercise with the given title and no Start the exercise message below it

Creating an mini-interactive-exercise in jEditOQMath and seeing it

This tasks explains how to create a trivial interactive exercise in source form and see it in the exercise system.

Prerequisite:

Task steps

  • we continue where the task add a static exercise stopped, namely, while editing the exercise of id mini-exercise inside the file first.oqmath
  • put the cursor below the CMP element but before </exercise>
  • now we add a first interaction element
    • type <, i, n, then space, then add the id attribute, e.g. id="mini-entry", then type >
    • then input feedback with a CMP element in a next line: <feedback><CMP>
    • inside there, we add the first presented text, for example, The exercise will just ask for a number to be input in the box:
    • at this point we add a formula with an id by providing an input such as $id("numberInput",x)$ which just puts the term with the sole term made by the variable x along with an id for it
    • close CMP and feedback elements (type twice < followed by /)
    • save and fix any errors appearing in the error console tab on the top of the window
  • we now declare that the variable x should be an input-zone by adding, after the feedback element, the interaction_map that indicates that this id should be replaced by a blank: <interaction_map> <blank for="numberInput"/> </interaction_map>

    • for such an input to be processed we must now sort on possible answers by the addition of an answermap_ which will branch to the possible interactions.
    • start an answer_map element
    • add a default child of it pointing to an interaction that is still to be made, for example, type <default xref="mini-exo-always-finishes">
    • inside this answer map entry, that catches all possibilities, add a diagnosis indicating the score thus performed: <diagnosis><achievement value="1.0"/>
    • close default and answer_map elements
    • now create the final interaction, for example with the following code to be put after the answer_map.

      <interaction id="mini-exo-always-finishes">
        <feedback><CMP>Fantastic, we're already through.</CMP></feedback>
      </interaction>
      
  • save and correct any validation errors

  • open the Ant Farm tab on the left of jEditOQMath, select the build file of the collection you are running, click the running man, and wait that “BUILD SUCCESSFUL” appears in the console below

  • navigate with your browser to the book of your collection then to the exericise on bottom of first page. You may need to reload the browser window.
  • a link Start the exercise should appear
  • click it see the exercise and the input field
  • input a value (actually anything) then submit
  • see the message You can now close your window

Beyond this Task

Task: download eXtasy source and insert into own collection

This tasks explains how to download an extasy exercise into one’s own collection.

Prerequisite:

  • create-collection
  • usage of eXtasy exercise authoring tool
  • applications-on: jEditOQMath, ActiveMath, web-browser

Task steps

  • in the first eXtasy window, having chosen a collection, it is possible to preview or source items of the collection. Choose the exercise you wish then request source
  • the OMDoc file is now downloaded to your browser… depending on your browser, you will get either a very little amount of text (typical of Safari), or an XML display which looks like a source (typical of Mozilla). Do not copy this.
  • either save this file (FIle > Save As…) or View the source and copy this
  • save the content inside your collection, within the oqmath directory, under a file-name which ends with .oqmath
  • open this file in jEditOQMath. Typically it looks fairly ugly because it has neither marks of being XML nor a clean indenting
  • invoke the command OQMath > Clean-up-OMDoc, save the file (File > Save), close-it and re-open it
  • you should now get a file editted in XML-mode and validation should run automatically
  • in the status bar, you should now see XML parsing complete, 0 error(s).. Should that number be non-null, please try to fix the errors
  • now open the Ant Farm tab on the left, locate the the build-file of the collection where you saved your file (e.g. My collection), select it, and press the running man to start it
  • if all goes well, you should obtain zero errors and the exercise should appear within a new page of the automatic-recorded-book

A more experimental way, for those who intend to edit this file further in jEditOQMath, is to use OQMath > OMDoc2 OQMath which will convert all formulæ to QMath using the notations of this collection.

Re-use and Publication Tasks

The following tasks will be presented:

Task: applying a creative commons license to an OMDoc file

The goal of this task is to choose a creative-commons license then apply it in the OMDoc file using jEditOQMath.

Prerequisite

create-a-collection

Applications That Should be Running

jEditOQMath, ActiveMath, web-browser

Task description

  • we first identify the URL to the appropriate license description, here is how to obtain a Creative Commons Attribution Sharealike, my recommendation for re-usable shared content:
    • using your web-browser go to creative-commons.org
    • click license your work
    • you should land on a page in (one of) the language(s) of your country
    • choose the options that you wish apply to your license. For the license above, choose allow commercial usage and allow modifications as long as published under the same license
    • press choose license
    • you should obtain a page with advice on how to embed the license in several document formats
    • there should also be a link see how the license will look which is a link to a human-readable description of the license, linked to a legally formal text, copy that link. In my case, it was http://creativecommons.org/licenses/by-sa/2.0/de/
  • we now apply this license to the complete omdoc element in the file first.oqmath that we created while starting a collection:
    • in jEditOQMath, open the file first.oqmath
    • near the top, find the opening tag <omdoc> (which could have an id attribute maybe)
    • shortly below, an opening tag <metadata> should appear which, typically, contains Title and Contributor elements. Insert an empty line before the </metadata> closing tag.
    • insert then, the element Rights with a content as follows:

-

<Rights>Distributed under the license
    <omlet type="hyperlink" 
     data="http://creativecommons.org/licenses/by-sa/2.0/de/">Creative`
        Commons Attribution Share-alike</omlet>.
  </Rights>
  • -
    • save the file (C-S), select the AntFarm Tab on the left, find the appropriate build-file of your collection, double-click it (or select it and press the running man)
    • wait till the console pane which appeared on the bottom of the window tells you BUILD SUCCESSFUL
  • we now observe how, in ActiveMath, this license grant can be seen:
    • go, with your web-browser, to your ActiveMath
    • open the book of your collection, find the page that has been produced by first.oqmath (typically, My first OMDoc)
    • click the title of any item of this page, the Item menu appears
    • choose See copyright statement (or See contributors)
    • a little window should pop-up with the text that we have put inside the Rights element
    • the text of the license title should be clickable… to the human-readable license

Task-video: choosing and applying a license

First stab at a video presentation of choosing and applying a license can be seen.

Writing conventions

This page describes the style for writing tasks.

Here are a few recommendations while writing a task:

Same tools and words

Make sure that you achieve the task with the exact same tools as a normal author, this means using ActiveMath-SVN and jEditOQMath Make sure you use the same wording as can be seen in these user-interfaces

Typography

Organization

A test ? Make a video and see if that works well.