|
|
# Generality
|
|
|
For the moment, configuration of axis, types of tool and tools can only be done directly to database. This is a functionality to develop.
|
|
|
At the moment, the configuration of axes, types of tools, and tools can only be done directly in the database. Current development will provide an UI for teachers to build their annotation palettes.
|
|
|
|
|
|
All objects can be customize. The objects are distributed as follows :
|
|
|
* axe_1
|
|
|
All objects can be customized. The objects are distributed as follows:
|
|
|
* axis_1
|
|
|
* tool_1_1
|
|
|
* tool_1_2
|
|
|
* tool_1_n
|
|
|
* axe_2
|
|
|
* axis_2
|
|
|
* tool_2_1
|
|
|
* ...
|
|
|
* tool_2_n
|
|
|
* ...
|
|
|
* axe_n
|
|
|
* axis_n
|
|
|
* tool_n_1
|
|
|
* ...
|
|
|
* tool_n_n
|
|
|
|
|
|
All tables begin with **mdl_assignfeedback_editpp_**
|
|
|
All tables begin with **{assignfeedback_editpp_}**
|
|
|
|
|
|
# Axis
|
|
|
## Structure
|
|
|
**mdl_assignfeedback_editpp_axis**
|
|
|
DB table: **{assignfeedback_editpp_axis}**
|
|
|
|
|
|
| contextid | label | order |
|
|
|
| --------- | ----- | ----- |
|
|
|
| Context to which the axis | The name of the axis | The order of appearance of the axis |
|
|
|
| Context to which the axis belongs | The name of the axis | The order of appearance of the axis in this context |
|
|
|
|
|
|
## Configuration
|
|
|
Set the data here to create new axis. Set "1" into context if you want that you're axis appears on all courses.
|
|
|
Set the data here to create new axis. Set context to '1' (site context) if you want the axis to appear throughout the whole Moodle site.
|
|
|
|
|
|
## Example
|
|
|
| contextid | label | order |
|
... | ... | @@ -36,28 +36,28 @@ Set the data here to create new axis. Set "1" into context if you want that you' |
|
|
| 1 | Axis 2 : contents | 2 |
|
|
|
| 1 | Axis 3 : others | 3 |
|
|
|
|
|
|
Which will make --> ![Sélection_001](/uploads/639c308021b94d86a16935d486f22c45/Sélection_001.png)
|
|
|
Which will render as: ![Sélection_001](/uploads/639c308021b94d86a16935d486f22c45/Sélection_001.png)
|
|
|
|
|
|
# Tool type
|
|
|
## Structure
|
|
|
**mdl_assignfeedback_editpp_typet**
|
|
|
DB table: **{assignfeedback_editpp_typet}**
|
|
|
|
|
|
All tools have a type, a kind of model. All proprieties, as colour, can be overloaded in tool definition.
|
|
|
All tools have a type, which is a kind of a tool template. All proprieties have default values and can be overridden in the tool definition.
|
|
|
|
|
|
| contextid |label | color | cartridge_color | cartridge_x | cartridge_y|
|
|
|
| --------- | ----- | ----- | ----- | ----- | ----- |
|
|
|
| Context to which the axis | Name of the type of tool | Default colour of the drawing | Default colour of cartridge label | Default x position of cartridge relative to the annotation's position | Default y position of cartridge relative to the annotation's position |
|
|
|
| Context to which the axis | Name of the type of tool | Default color of the drawing | Default color of cartridge label | Default x position of cartridge relative to the annotation's position | Default y position of cartridge relative to the annotation's position |
|
|
|
|
|
|
We have make 6 new types of tool (highlightplus, stampplus, frame, verticalline, stampcomment and commentplus). If you remove one line, you won't be able to use a tool with this type.
|
|
|
|
|
|
Label will never appears, but don't change it at all, their are part of clue in script.
|
|
|
Label will never appear, but don't change it at all, their are part of clue in script.
|
|
|
|
|
|
## Configuration
|
|
|
You can change default values, as colour and position. Type of tool can be reserved to a particular context.
|
|
|
You can change default values, as color and position. Type of tool can be reserved to a particular context.
|
|
|
|
|
|
You can let "null" value, there is default value for all types in the application.
|
|
|
|
|
|
Note: for previous tools (pen, line, rectangle, oval, highlight), there is no default properties to set : their are define directly by the user when he draw the annotation.
|
|
|
Note: for standard tools (pen, line, rectangle, oval, highlight), there is no properties to set. These are set by the user when drawing the annotation.
|
|
|
|
|
|
## Example
|
|
|
| contextid |label | color | cartridge_color | cartridge_x | cartridge_y|
|
... | ... | @@ -77,25 +77,25 @@ Note: for previous tools (pen, line, rectangle, oval, highlight), there is no de |
|
|
## Description of new types
|
|
|
| Type | Annotation |Example |
|
|
|
| ---- | ---------- | ------ |
|
|
|
| highlightplus | Composed by a highlight and a cartridge | ![Sélection_002](/uploads/c935faf9a2e302f10e68efff11a238fd/Sélection_002.png) |
|
|
|
| highlightplus | Made of a highlight and a cartridge | ![Sélection_002](/uploads/c935faf9a2e302f10e68efff11a238fd/Sélection_002.png) |
|
|
|
| stampplus | A stamp, with custom text | ![Sélection_004](/uploads/2ca273d9d3487e5df5af3058bb1aaff4/Sélection_004.png) |
|
|
|
| frame | Composed by one or several frame(s) around elements and a cartridge | ![Sélection_005](/uploads/b903b071cf840b4940398fbab2412542/Sélection_005.png) |
|
|
|
| verticalline | Composed by a vertical line and a cartridge | ![Sélection_006](/uploads/3462932630a761d3f22db97977ad292a/Sélection_006.png) |
|
|
|
| stampcomment | Composed by a stamp with a double arrow and a cartridge | ![Sélection_007](/uploads/9d180ebdea0f6a59b5002d89508b7411/Sélection_007.png) |
|
|
|
| frame | Made of one or several frame(s) around elements and a cartridge | ![Sélection_005](/uploads/b903b071cf840b4940398fbab2412542/Sélection_005.png) |
|
|
|
| verticalline | Made of a vertical line and a cartridge | ![Sélection_006](/uploads/3462932630a761d3f22db97977ad292a/Sélection_006.png) |
|
|
|
| stampcomment | Made of a stamp with a double arrow and a cartridge | ![Sélection_007](/uploads/9d180ebdea0f6a59b5002d89508b7411/Sélection_007.png) |
|
|
|
| commentplus | A simple comment | ![Sélection_008](/uploads/ea068af2007c83dfbb95904343bb69b6/Sélection_008.png) |
|
|
|
|
|
|
# Tool
|
|
|
## Structure
|
|
|
**mdl_assignfeedback_editpp_tool**
|
|
|
**{assignfeedback_editpp_tool}**
|
|
|
|
|
|
| contextid | axis | type | colors | cartridge | cartridge_color | texts | label | reply | enabled | order |
|
|
|
| --------- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- |
|
|
|
| Context to which the axis | id of its axis | id of its type of tool | Special color of annotation | Title of cartridge | Special color of cartridge | Recurring text content proposals | Label which will appear in tool bar | 1 of this tool is enabled | order in the tool bar |
|
|
|
|
|
|
## Configuration
|
|
|
You can create many tools you wish : just be careful for the display of the tools bar...
|
|
|
You can create as many tools as needed.
|
|
|
|
|
|
Colours are inherited from type of tool, but you can change them here.
|
|
|
Colors are inherited from type of tool, but you can change them here.
|
|
|
|
|
|
## Example
|
|
|
You will probably need these base tools:
|
... | ... | @@ -108,9 +108,9 @@ You will probably need these base tools: |
|
|
| 1 | 0 | 11 | NULL | NULL | NULL | NULL | oval | 0 | 1 | NULL |
|
|
|
| 1 | 0 | 12 | NULL | NULL | NULL | NULL | highlight | 0 | 1 | NULL |
|
|
|
|
|
|
Note the id of the axis: has it's base tools from the editpdf plugin, axis is **0**.
|
|
|
Note the reference to axis 0: this allows to display the standard tools, independently of any axis (they are always visible to the user).
|
|
|
|
|
|
And you can create custom tools, like:
|
|
|
And you can create custom tools, for instance:
|
|
|
|
|
|
| contextid | axis | type | colors | cartridge | cartridge_color | texts | label | reply | enabled | order |
|
|
|
| --------- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- |
|
... | ... | @@ -124,7 +124,7 @@ And you can create custom tools, like: |
|
|
| 1 | 3 | 3 | green | NULL | NULL | NULL | ✔ | 0 | 1 | 2 |
|
|
|
| 1 | 3 | 5 | #FF6F40 | Formatting | #FF6F40 | "identation","order" | FORM | 1 | 1 | 3 |
|
|
|
|
|
|
This will render:
|
|
|
This will render as:
|
|
|
|
|
|
Axis 1
|
|
|
![Sélection_009](/uploads/0d2b8a9cf5cfa15027835f6575bb2bdb/Sélection_009.png)
|
... | ... | @@ -152,4 +152,3 @@ Axis 3 |
|
|
| Useless | ![Sélection_023](/uploads/7db74cd2c7b7705159ba87b6bc40c49c/Sélection_023.png) | ![Sélection_024](/uploads/7b3a8190348f1a12fea57ca28d888d59/Sélection_024.png) |
|
|
|
| ✔ | | ![Sélection_025](/uploads/b6a76949ea136a958ebc9a0209a28466/Sélection_025.png) |
|
|
|
| Form | ![Sélection_027](/uploads/e6b553faee6cadbba4552d4829c326c2/Sélection_027.png) | ![Sélection_028](/uploads/a4533b975d8cfeebb995d114be9681a3/Sélection_028.png) | |
|
|
|