From e816fae7b11c23d85bafea0040b40d35371ae821 Mon Sep 17 00:00:00 2001 From: Fred Date: Wed, 14 Oct 2015 07:59:27 +0200 Subject: [PATCH] (re)structure files --- INSTALL.md | 27 --------------------------- README.md | 29 +++++++++++++++++++++++------ SUMMARY.md | 10 ---------- admin.md => ideas/admin.md | 0 ideas/django-patterns.md | 11 +++++++++++ {annex => ideas}/legacy.md | 0 stack.md => ideas/stack.md | 0 patterns.md | 23 ----------------------- patterns/.md | 1 - patterns/models.md | 1 - patterns/template.md | 1 - patterns/view.md | 1 - 12 files changed, 34 insertions(+), 70 deletions(-) delete mode 100644 INSTALL.md delete mode 100644 SUMMARY.md rename admin.md => ideas/admin.md (100%) create mode 100644 ideas/django-patterns.md rename {annex => ideas}/legacy.md (100%) rename stack.md => ideas/stack.md (100%) delete mode 100644 patterns.md delete mode 100644 patterns/.md delete mode 100644 patterns/models.md delete mode 100644 patterns/template.md delete mode 100644 patterns/view.md diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 09d31db..0000000 --- a/INSTALL.md +++ /dev/null @@ -1,27 +0,0 @@ -# Installation - -## Prérequis - -`sudo aptitude install nodejs`. -Après cela, lance `npm install` qui ira récupérer le contenu du fichier `package.json`. - -## Editeur - -Il existe un éditeur pour Gitbook, qui offre pas mal de fonctionnalités sans avoir à tripatouiller la documentation; il est disponible à [l'adresse suivante](https://www.gitbook.com/editor/linux). - -Pour l'installation, un petit `dpkg -i gitbook-editor.x.y.z.deb`. -Seul soucis: un compte Gitbook est requis. - -# Initialisation - -L'initiation du contenu peut se faire une fois que le module `gitbook-cli`aura été installé, grâce à la commande `nodejs node_modules/gitbook-cli/bin/gitbook.js init `. -Cette commande se base sur le fichier `SUMMARY.md` pour générer l'arborescence correcte des fichiers (vides, dans un premier temps). - -# Compilation - - * `nodejs node_modules/gitbook-cli/bin/gitbook.js build` - * `nodejs node_modules/gitbook-cli/bin/gitbook.js serve` - -## Formats supportés - -Pour les formats autres que HTML (PDF, Mobi & ePub), il faut installer `Calibre` grâce à un `aptitude install Calibre`. Attention qu'il y a un bon petit 300MB de dépendances... diff --git a/README.md b/README.md index 6d90c91..09d31db 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,27 @@ -# Django +# Installation -[Django](https://www.djangoproject.com/) est l'un des frameworks Web proposant une très bonne intégration des composants, et une flexibilité bien pensée: chacun des composants permet de définir son contenu de manière poussée, en respectant des contraintes logiques et faciles à retenir. +## Prérequis -En restant dans les sentiers battus, votre projet suivra le patron de conception `MVC` (Modèle-Vue-Controleur), avec une petite variante sur les termes utilisés: Django les nomme respectivement Modèle-Template-Vue: +`sudo aptitude install nodejs`. +Après cela, lance `npm install` qui ira récupérer le contenu du fichier `package.json`. - * Le modèle (`models.py`) fait le lien avec la base de données et permet de définir les champs et leur type à associer à une table. *Grosso modo*, une table SQL correspondra à une classe d'un modèle Django. - * La vue (`views.py`), qui joue le rôle de contrôleur: *a priori*, tous les traitements, la récupération des données, etc. doit passer par ce composant et ne doit (pratiquement) pas être généré à la volée, directement à l'affichage d'une page. - * Le template, qui s'occupe de la mise en forme: c'est le composant qui va s'occuper de transformer les données en un affichage compréhensible (avec l'aide du navigateur) pour l'utilisateur. +## Editeur +Il existe un éditeur pour Gitbook, qui offre pas mal de fonctionnalités sans avoir à tripatouiller la documentation; il est disponible à [l'adresse suivante](https://www.gitbook.com/editor/linux). + +Pour l'installation, un petit `dpkg -i gitbook-editor.x.y.z.deb`. +Seul soucis: un compte Gitbook est requis. + +# Initialisation + +L'initiation du contenu peut se faire une fois que le module `gitbook-cli`aura été installé, grâce à la commande `nodejs node_modules/gitbook-cli/bin/gitbook.js init `. +Cette commande se base sur le fichier `SUMMARY.md` pour générer l'arborescence correcte des fichiers (vides, dans un premier temps). + +# Compilation + + * `nodejs node_modules/gitbook-cli/bin/gitbook.js build` + * `nodejs node_modules/gitbook-cli/bin/gitbook.js serve` + +## Formats supportés + +Pour les formats autres que HTML (PDF, Mobi & ePub), il faut installer `Calibre` grâce à un `aptitude install Calibre`. Attention qu'il y a un bon petit 300MB de dépendances... diff --git a/SUMMARY.md b/SUMMARY.md deleted file mode 100644 index 0193222..0000000 --- a/SUMMARY.md +++ /dev/null @@ -1,10 +0,0 @@ -# Table des matières - -This is the summary of my book. - -* [Ressources](resources.md) -* [Patterns](patterns/introduction.md) - * [Modèle](patterns/models.md) - * [Vue](patterns/view.md) - * [Template](patterns/template.md) -* [Administration](admin.md) diff --git a/admin.md b/ideas/admin.md similarity index 100% rename from admin.md rename to ideas/admin.md diff --git a/ideas/django-patterns.md b/ideas/django-patterns.md new file mode 100644 index 0000000..acec614 --- /dev/null +++ b/ideas/django-patterns.md @@ -0,0 +1,11 @@ +# Django + +[Django](https://www.djangoproject.com/) est l'un des frameworks Web proposant une très bonne intégration des composants, et une flexibilité bien pensée: chacun des composants permet de définir son contenu de manière poussée, en respectant des contraintes logiques et faciles à retenir. + +En restant dans les sentiers battus, votre projet suivra le patron de conception `MVC` (Modèle-Vue-Controleur), avec une petite variante sur les termes utilisés: Django les nomme respectivement Modèle-Template-Vue: + + * Le modèle (`models.py`) fait le lien avec la base de données et permet de définir les champs et leur type à associer à une table. *Grosso modo*, une table SQL correspondra à une classe d'un modèle Django. + * La vue (`views.py`), qui joue le rôle de contrôleur: *a priori*, tous les traitements, la récupération des données, etc. doit passer par ce composant et ne doit (pratiquement) pas être généré à la volée, directement à l'affichage d'une page. + * Le template, qui s'occupe de la mise en forme: c'est le composant qui va s'occuper de transformer les données en un affichage compréhensible (avec l'aide du navigateur) pour l'utilisateur. + + diff --git a/annex/legacy.md b/ideas/legacy.md similarity index 100% rename from annex/legacy.md rename to ideas/legacy.md diff --git a/stack.md b/ideas/stack.md similarity index 100% rename from stack.md rename to ideas/stack.md diff --git a/patterns.md b/patterns.md deleted file mode 100644 index 338d994..0000000 --- a/patterns.md +++ /dev/null @@ -1,23 +0,0 @@ -The CRUD views themselves are simple enough to be self-explanatory, as shown in -the following code: - -```python -# views.py -from django.core.urlresolvers import reverse_lazy -from . import forms - -class ImpDateDetail(generic.DetailView): - model = models.ImportantDate - - class ImpDateCreate(generic.CreateView): - model = models.ImportantDate - form_class = forms.ImportantDateForm - - class ImpDateUpdate(generic.UpdateView): - model = models.ImportantDate - form_class = forms.ImportantDateForm - - class ImpDateDelete(generic.DeleteView): - model = models.ImportantDate - success_url = reverse_lazy("impdate_list") -``` diff --git a/patterns/.md b/patterns/.md deleted file mode 100644 index 3c9daa3..0000000 --- a/patterns/.md +++ /dev/null @@ -1 +0,0 @@ -# Patterns diff --git a/patterns/models.md b/patterns/models.md deleted file mode 100644 index b6cf143..0000000 --- a/patterns/models.md +++ /dev/null @@ -1 +0,0 @@ -# Modèle diff --git a/patterns/template.md b/patterns/template.md deleted file mode 100644 index c296a5f..0000000 --- a/patterns/template.md +++ /dev/null @@ -1 +0,0 @@ -# Template diff --git a/patterns/view.md b/patterns/view.md deleted file mode 100644 index 9d38c2e..0000000 --- a/patterns/view.md +++ /dev/null @@ -1 +0,0 @@ -# Vue