readme.md 3.41 KB
Newer Older
Martin Lehoux's avatar
Martin Lehoux committed
1
# nofist-v2
Martin Lehoux's avatar
Martin Lehoux committed
2
## Cahier des charges
Raphaël Bolut's avatar
Raphaël Bolut committed
3
* Le diagramme UML des models est disponible : [models.png](https://gitlab.viarezo.fr/ViaRezo/nofist-v2/blob/master/models.png)
Martin Lehoux's avatar
Martin Lehoux committed
4
* Les fichiers seront stockés sous files/accepted pour ceux en ligne, et sous files/toAccept pour ceux en attente d'acceptation
Martin Lehoux's avatar
Martin Lehoux committed
5
* Structure du fichier core/conf.py :
Martin Lehoux's avatar
Martin Lehoux committed
6 7
    * client_id
    
Martin Lehoux's avatar
Martin Lehoux committed
8 9 10 11 12 13
## Table of contents
* [Repository Documentation](#repository-documentation)
    * [Labels](#labels)
* [Templates Documentation](#templates-documentation)
    * [Components](#components)

Martin Lehoux's avatar
Martin Lehoux committed
14 15 16 17 18 19 20
## Repository Documentation
### Labels
Here are labels and their meaning as they are used in this project. Feel free to add some if needed.

* Type :
  * ~feature
  * ~bug
Martin Lehoux's avatar
typo  
Martin Lehoux committed
21
* Subject :
Martin Lehoux's avatar
Martin Lehoux committed
22 23 24 25
    * ~front
    * ~back
    * ~documentation

Martin Lehoux's avatar
Martin Lehoux committed
26 27 28 29 30 31 32 33 34 35
## Templates Documentation
Templates are located in `core/templates/core`.

### Components
Components are located in `core/templates/core/components`.
These are litle bricks of templating rendering. It makes it possible to reduce the code length and to modify design on several pages.

#### `comment_list.html`
> Display a list of comments with a post field.

36
* `comment_list` : a list of comment objects
Martin Lehoux's avatar
Martin Lehoux committed
37 38 39
* `type` : comment type (`course`|`document`), needed for post request

#### `comment_moderation.html`
Martin Lehoux's avatar
Martin Lehoux committed
40 41
> Display a comment with Accept and Reject buttons for moderation purpose.

42 43
* `comment` : a comment object
* `type` : comment type (`course`|`document`)
Martin Lehoux's avatar
Martin Lehoux committed
44 45 46

#### `comment.html`
> Display a simple comment
Martin Lehoux's avatar
Martin Lehoux committed
47

48
* `comment` : a comment object
Martin Lehoux's avatar
Martin Lehoux committed
49 50 51 52 53 54 55

#### `contact.html`
> Display a short horizontal contact with photo, name, mail and role.

* `name` : a full name
* `email` : a simple email
* `photo` : a relative path to a photo inside `core/static/core/`
56 57 58 59 60
* `role` : role inside project

#### `course_full.html`
> Display a course with name, description, year, type, teachers.

Martin Lehoux's avatar
Martin Lehoux committed
61 62
* `course` : a course object

Martin Lehoux's avatar
Martin Lehoux committed
63
#### `course_moderation.html`
Martin Lehoux's avatar
Martin Lehoux committed
64 65
> Display a course with Accept and Reject buttons for moderation purpose.

Martin Lehoux's avatar
Martin Lehoux committed
66 67 68 69 70
* `course` : a course object

#### `course_sum.html`
> Display a course with fewer informations for multi-display purpose.

Martin Lehoux's avatar
Martin Lehoux committed
71 72
* `course` : a course object

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
#### `course_browser.html`
> Browse all courses through a accordion, grouping by year and type.

```javascript
courses: {
    A1: {
        tronc_commun: [],
        electif: []
    },
    A2: {
        tronc_commun: [],
        electif: []
    },
    A3: {
        tronc_commun: [],
        electif: []
    }
}
```


Martin Lehoux's avatar
Martin Lehoux committed
94 95 96
#### `document_full.html`
> Display a document with name, date, description and file download.

Martin Lehoux's avatar
Martin Lehoux committed
97 98 99 100 101
* `document` : a document object

#### `document_moderation.html`
> Display a document with Accept and Reject buttons for moderation purpose.

Martin Lehoux's avatar
Martin Lehoux committed
102 103 104 105 106
* `document` : a document object

#### `document_sum.html`
> Display a document with fewer informations for multi-display purpose.

Martin Lehoux's avatar
Martin Lehoux committed
107 108
* `document` : a document object

109 110 111 112 113 114 115 116
#### `message.html`
> Display in a specified style messages for user.

* `message` : a message object
  * `type` in (`info`|`warning`|`error`)
  * `header`
  * `content`

Martin Lehoux's avatar
Martin Lehoux committed
117 118 119 120
#### `navbar.html`
> Display navigation menu in top screen, with active item management and user conditions.

* `user` : an user object, needed for personnalisation and authorization
Martin Lehoux's avatar
Martin Lehoux committed
121 122 123
* `item` : page name to display differently active menu items

#### `searchbar.html`
Martin Lehoux's avatar
Martin Lehoux committed
124
> Display a Search Bar. **This feature is not available.**
Martin Lehoux's avatar
Martin Lehoux committed
125 126 127 128

#### `teacher_moderation.html`
> Display a teacher with Accept and Reject buttons for moderation purpose.

129
* `teacher` : a teacher object