forked from root/public
3 changed files with 63 additions and 0 deletions
@ -0,0 +1,34 @@ |
|||||||
|
# Objects Edition |
||||||
|
|
||||||
|
> Allow you to edit an object, see and manage its relations. |
||||||
|
|
||||||
|
## Page Composition |
||||||
|
|
||||||
|
![object-edit-overview](https://user-images.githubusercontent.com/15313830/56667480-ceff8500-66a5-11e9-98c7-792d598f2394.png) |
||||||
|
|
||||||
|
### Pin 1 |
||||||
|
|
||||||
|
- Link back to the "Objects" page ; |
||||||
|
- Editable name field, hit 'enter' or 'cmd + s' or click on the floppy-disk icon to save ; |
||||||
|
- Major dependencies visualisation, (where my object is used as a child), click the label to navigate to the dependence ; |
||||||
|
- External URL, this is an optional parameter, it's use to point at an other source of content or information needed by the object. We generaly use to point at a Git repository ; |
||||||
|
|
||||||
|
### Pin 2 |
||||||
|
|
||||||
|
- Delete Button, Warning there, it will destroy your object! ; |
||||||
|
- Type of your Object (`organisation`, `campus`, `onboarding`, `cursus`, `quest`, `exercise`), save on select ; |
||||||
|
- Status of your Object (`draft`, `online`, `offline`), save on select ; |
||||||
|
- The first and last name of the original author ; |
||||||
|
|
||||||
|
### Pin 3 |
||||||
|
|
||||||
|
- Object Attribute edition area, manage all the attributes relative to this Object. These attributes will be exposed to its relationship ; |
||||||
|
|
||||||
|
### Pin 4 |
||||||
|
|
||||||
|
- Object Children edition area ; |
||||||
|
- Children Attributes edition area, these attributes impact and overload all the following children. Works the same way as standard attributes ; |
||||||
|
- Add a child, allows to add a child to the children list, more information here -> [Object Child creation](https://github.com/01-edu/public/blob/master/doc/object-child-creation.md) ; |
||||||
|
- Children List, allows you to reorganise, delete and edit child. Each child can be overload with its own attributes, the edition works the same way as the original attributes ; |
||||||
|
|
||||||
|
More informations about attribute overload system [here] ((https://github.com/01-edu/public/blob/master/doc/object-attribute-overload-system.md) |
@ -0,0 +1,29 @@ |
|||||||
|
# Objects |
||||||
|
|
||||||
|
> Allow you to create, manage and organize your pedagical and onboarding content. |
||||||
|
|
||||||
|
## Definition |
||||||
|
|
||||||
|
An Object is an highly customizable element, which can be use in many situations. We use it to compose cursuses and onboarding processes. |
||||||
|
Objects can be associated together and then share a vertical or horizontal relationship, which allows to build complex structure of multiple objects. |
||||||
|
|
||||||
|
It structure can be visualized in two parts. The first one is the definition of the object itself and attributes, called `attrs`. The second part is the definition of minor relationships, called `children` and attributes applied to them, called `childrenAttrs`. |
||||||
|
|
||||||
|
This is the minimal structure of an object: |
||||||
|
|
||||||
|
- name |
||||||
|
- type (`organisation`, `campus`, `onboarding`, `cursus`, `quest`, `exercise`) |
||||||
|
- status (`draft`, `online`, `offline`) |
||||||
|
- attrs {} |
||||||
|
- childrenAttrs {} |
||||||
|
- children {} |
||||||
|
|
||||||
|
## Browse Objects: |
||||||
|
|
||||||
|
To access your Objects, go to the admin dashboard and then click on the _manage object_ link within the "Object" card. |
||||||
|
|
||||||
|
![go-to-objects](https://user-images.githubusercontent.com/15313830/56653756-46bdb780-6686-11e9-98ba-18e382987e9c.png) |
||||||
|
|
||||||
|
Objects are sorted by type in different sections. This page offer a search bar that allow you query the objects by name. In the top-right corner, click the _add a new object_ button to create a new object. Fill a name, select a type and click _create_ to validate your creation. You will be redirected to the Object Edition page (document is here). |
||||||
|
|
||||||
|
![all-object-page](https://user-images.githubusercontent.com/15313830/56654475-137c2800-6688-11e9-880b-75092397890d.png) |
Loading…
Reference in new issue