Technical Documentation Edito
From PatioWiki
In the Edito module we have implemented the management of concepts, multimedia resources, pupils and syllable division.
Contents |
Concept Management
In the use case diagram of the concept management you can visualize the available actions that you can perform on a concept, such as Add concept, Modify concept, Delete concept and Relate concepts.
In the class diagram of the concept management you can visualize the main classes used for handling concepts. There are panels for concept management (ConceptPropertiesPanel), concept association management (ConceptAssociationPanel) and relation type management (ConceptRelationTypePanel) included into the main panel (ConceptPresenterPanel). Furthermore, you can visualize the class ConceptImagesPanel which manages the relations between concepts and multimedia resources, as well as the class ConceptTreePanel which contains the tree for selecting concepts.
Multimedia Resource Management
In the use case diagram of the multimedia resource management you can visualize the available action that you can perform on a multimedia resource, such as Add multimedia resource, Modify multimedia resource, Delete multimedia resource y Add a batch. Note that when you add or modify a multimedia resource you can also Associate it with a concept.
In the class diagram of the multimedia resource management you can visualize the main classes used for handling multimedia resources. Note that tabs for editing resources (MultimediaEditionPanel), addition of resources (MultimediaAdditionPanel) and addition of batches of resources (MultimediaBatchAdditionPanel) are included into the main tab panel (MultimediaTabbedPane). Furthermore, you can visualize the class MultimediaTreePanel which is used to contain the tree for selecting multimedia resources.
In the next diagram you can visualize the classes of the available data types which can be used to insert multimedia resources into the multimedia resources tree.
Pupil management
In the use case diagram of the pupil management you can visualize the available action that you can perform on a pupil's record, such as Add pupil, Modify pupil, Delete pupil (provided that she has not been included in Sessions or Logs) and Change of group.
In the class diagram of the pupil management you can visualize the main classes used for handling pupils. Note that the diagram includes the panel for editing pupils (StudentEditionPanel), the panel for the pupil's tree (StudentsTreeEditionPanel) and the panel that contains the data of the pupil is being edited (StudentsPropertiesPanel). Furthermore, you can visualize the class hierarchy for the types of nodes which can be included into the pupils tree. Each node can be an instance of SchoolTreeItem if it is for a school, GroupTreeItem for a group or StudentTreeItem for a pupil.
Syllable division management
In the use case diagram of the division management you can visualize the available action that you can perform on a syllable division, such as Add syllable division or Delete syllable division.
In the class diagram of the syllable division management you can visualize the main classes used for handling syllable divisions. Note that there are a panel for editing SyllableEditionPanel, another for including the concept tree SyllableTreeEditionPanel and another for the syllable divisions SyllablePropertiesPanel. You can also visualize the classes LeoLetterSyllableTreeItem and LeoWordSyllableTreeItem which are both children of the AbstractSyllableTreeItem class.
