Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nettoyage #1505

Merged
merged 48 commits into from
Sep 17, 2014
Merged
Show file tree
Hide file tree
Changes from 44 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
f205584
Use wraps decorator and remove manually wrapping properties
Sep 11, 2014
1ee9fab
Rename parameter hiding build in type
Sep 11, 2014
f6ef86b
Avoid crash if dictionary is not correctly formatted
Sep 11, 2014
d9c5e13
Simplify argument list rendering
Sep 11, 2014
713dff2
Adding doc string
Sep 11, 2014
85e6c58
Add double underscore to private member.
Sep 11, 2014
e4cf402
Rewrite argument list parsing handling bad formatted argument list
Sep 11, 2014
181a83e
Change formatting from old style to new one
Sep 11, 2014
087f439
Improve error message
Sep 11, 2014
5d5526d
not used parameter
Sep 11, 2014
4361f20
Small correction
Sep 11, 2014
31b5b26
Typo
Sep 11, 2014
4683144
Use Djando/Tag template function.
Sep 11, 2014
c0eb22b
Rename variable and members
Sep 11, 2014
e80bfe3
Remove useless args
Sep 11, 2014
658cbb5
Add doc string
Sep 11, 2014
ee6a8d7
Rename unused variable.
Sep 11, 2014
37275f1
Factorize error catch
Sep 11, 2014
4e8fc91
Set all base string formatting on the module beginning
Sep 11, 2014
9d32c3d
Use named argument for boolean parameters
Sep 11, 2014
1d69098
factorize standard output call.
Sep 11, 2014
19d434e
Fix encoding
Sep 11, 2014
5029bbd
Doc string
Sep 11, 2014
26e918a
remove useless filter argument.
Sep 11, 2014
26c120d
Move humane_time filter to date module (not related to markdown)
Sep 11, 2014
da0a2f4
Factorise markdown header shift "decale_header"
Sep 11, 2014
86588e7
Factorize markdown render + docstring
Sep 11, 2014
4c55549
Docstring + comments
Sep 11, 2014
2bbb142
Docstring + comments
Sep 11, 2014
43c66c5
Add test directory
Sep 11, 2014
f2e45ef
Fix: Django do not like partial :(
Sep 11, 2014
11a47d9
Fix: allowing empty list in AppendGetNode
Sep 11, 2014
14d72ef
Fix: Check value not empty in AppendGetNode
Sep 11, 2014
584a6dd
Add Test for "append_to_get" module
Sep 11, 2014
7e0eaf4
Add Test for "captureas" module
Sep 11, 2014
dc731cf
move const string on top of the module
Sep 12, 2014
481b314
Better timedelta argument passing
Sep 12, 2014
528c3d2
Add tests to "date" templatetags module
Sep 12, 2014
f267126
Fix: Markdown inline not propagated
Sep 12, 2014
e96b3b6
Fix: Only add complete match from all
Sep 12, 2014
f41ef8e
Fix: shift header
Sep 12, 2014
32a677d
Add test to "emarkdown" template tags
Sep 12, 2014
13230e7
Fix doc string comment
Sep 12, 2014
613f557
Complete doc
Sep 12, 2014
b214115
Remove redundant module loading
Sep 12, 2014
a9837de
pep-8 correction
Sep 16, 2014
e661525
Merge branch 'clean_templatetags' of github.com:cgabard/zds-site into…
Sep 16, 2014
da96e7a
Merge with dev
Sep 16, 2014
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions doc/sphinx/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sphinx-quickstart le Samedi 30 Août 2014 à 12:10:30.

Documentation de Zeste De Savoir
===========================================
================================

Sommaire:

Expand All @@ -15,12 +15,13 @@ Sommaire:
forum/forum.rst
gallery/gallery.rst
article/article.rst

utils/utils.rst




Index et tableaux
==================
=================

* :ref:`genindex`
* :ref:`modindex`
Expand Down
14 changes: 8 additions & 6 deletions doc/sphinx/source/install/install-linux.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
========================
=======================
Installation sous Linux
========================
=======================

Pour installer une version locale de ZdS sur GNU/Linux, veuillez suivre les instructions suivantes.
Si une commande ne passe pas, essayez de savoir pourquoi avant de continuer.
Expand Down Expand Up @@ -31,7 +31,7 @@ Ou, en une ligne,
easy_install pip

Instalation et configuration de `virtualenv`
===========================================
============================================

(cette étape n'est pas obligatoire, mais fortement conseillée)

Expand All @@ -48,20 +48,22 @@ Instalation et configuration de `virtualenv`
source zdsenv/bin/activate


Pour sortir de votre environnement : ``deactive``

Une documentation plus complète de cet outil [est disponible ici](http://docs.python-guide.org/en/latest/dev/virtualenvs/).

Front ou Back ?
===============

Si vous ne comptez qu'au back-end du site, téléchargez le zip des ressources `ici <http://zestedesavoir.com/static/pack.zip>`_
Il faudra l'extraire dans le dossier `dist/` à la racine de votre projet.
Il faudra l'extraire dans le dossier ``dist/`` à la racine de votre projet.

Si vous comptez contribuer au front-end, rendez-vous sur [la documentation dédiée](gulp.md).

Lancer ZdS
===============
==========

Une fois dans votre environnement python (`source ../bin/activate` si vous utilisez virtualenv, très fortement conseillé), lancez l'installation complète :
Une fois dans votre environnement python (``source ../bin/activate`` si vous utilisez virtualenv, très fortement conseillé), lancez l'installation complète :

.. sourcecode:: bash

Expand Down
14 changes: 7 additions & 7 deletions doc/sphinx/source/install/install-os-x.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
========================
======================
Installation sous OS X
========================
======================

Pour installer une version locale de ZdS sur OS X, veuillez suivre les instructions suivantes.
Si une commande ne passe pas, essayez de savoir pourquoi avant de continuer.
Expand Down Expand Up @@ -28,7 +28,7 @@ Installation de virtualenv


Création de votre environnement
==========================
===============================

.. sourcecode:: bash

Expand Down Expand Up @@ -56,7 +56,7 @@ Front ou Back ?
===============

Si vous ne comptez qu'au back-end du site, téléchargez le zip des ressources `ici <http://zestedesavoir.com/static/pack.zip>`_
Il faudra l'extraire dans le dossier `dist/` à la racine de votre projet.
Il faudra l'extraire dans le dossier ``dist/`` à la racine de votre projet.

Si vous comptez contribuer au front-end, rendez-vous sur la documentation dédiée.

Expand All @@ -70,11 +70,11 @@ Installation de toutes les dépendances
gulp build


Pour relancer votre environnement : `source ~/.virtualenvs/zdsenv/bin/activate`
Pour sortir de votre environnement : `deactive`
Pour relancer votre environnement : ``source ~/.virtualenvs/zdsenv/bin/activate``
Pour sortir de votre environnement : ``deactive``

Aller plus loin
================
===============

Pour faire fonctionner ZdS dans son ensemble vous devez installer les outils LateX et Pandoc.

Expand Down
42 changes: 21 additions & 21 deletions doc/sphinx/source/install/install-windows.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=========================================
==========================================
Installation sous **Windows 7, 8** et plus
=========================================
==========================================

Pour installer une version locale de ZdS sur Windows, veuillez suivre les instructions suivantes.
Si une commande ne passe pas, essayez de savoir pourquoi avant de continuer.
Expand All @@ -12,38 +12,38 @@ Prérequis
- `PowerShell 3.0+ <http://www.microsoft.com/fr-fr/download/details.aspx?id=40855>`_
- `Git <http://git-scm.com/download/win>`_ (Git pour Eclipse ne suffit pas ; associez les .sh)
- [Téléchargez et installez Python 2.7](https://www.python.org/download/releases/2.7/)
- Installez setuptools : Démarrez `Powershell <http://fr.wikipedia.org/wiki/Windows_PowerShell>`_ **en mode administrateur** et lancez la commande suivante : `(Invoke-WebRequest https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py).Content | python -`
- Installez setuptools : Démarrez `Powershell <http://fr.wikipedia.org/wiki/Windows_PowerShell>`_ **en mode administrateur** et lancez la commande suivante : ``(Invoke-WebRequest https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py).Content | python -``
- Redémarrez Powershell
- Installez pip : `easy_install pip`
- Désactivez la sécurité sur les script powershell `Set-ExecutionPolicy RemoteSigned`
- Installez pip : ``easy_install pip``
- Désactivez la sécurité sur les script powershell ``Set-ExecutionPolicy RemoteSigned``
- Installez Virtualenv avec les commandes suivante :
- `pip install virtualenv`
- `pip install virtualenvwrapper-powershell`
- ``pip install virtualenv``
- ``pip install virtualenvwrapper-powershell``
- Créez votre workspace dédié à ZdS
- `set $env:WORKON_HOME`
- `mkdir '~\.virtualenvs'`
- `Import-Module virtualenvwrapper`
- `New-VirtualEnvironment zdsenv --no-site-packages`
- Cloner le dépot git *via la console git* (et pas via powershell) windows: `git clone https://github.com/zestedesavoir/zds-site.git`
- ``set $env:WORKON_HOME``
- ``mkdir '~\.virtualenvs'``
- ``Import-Module virtualenvwrapper``
- ``New-VirtualEnvironment zdsenv --no-site-packages``
- Cloner le dépot git *via la console git* (et pas via powershell) windows: ``git clone https://github.com/zestedesavoir/zds-site.git``

Front ou Back ?
=========
===============

Si vous ne comptez qu'au back-end du site, téléchargez le zip des ressources `ici <http://zestedesavoir.com/static/pack.zip>`_
Il faudra l'extraire dans le dossier `dist/` à la racine de votre projet.
Il faudra l'extraire dans le dossier ``dist/`` à la racine de votre projet.

Si vous comptez contribuer au front-end, rendez-vous sur [la documentation dédiée](gulp.md).

Suite de l'installation
=========
=======================

- Dans la console PowerShell via l'environnement zdsenv installez les dépendances.
- `easy_install lxml`
- `pip install -r requirements.txt`
- `python manage.py syncdb`
- `python manage.py migrate`
- `python manage.py runserver`
- Pour redémarrer virtualenv les fois suivantes : `~\.virtualenvs\zdsenv\Scripts\activate.ps1`
- ``easy_install lxml``
- ``pip install -r requirements.txt``
- ``python manage.py syncdb``
- ``python manage.py migrate``
- ``python manage.py runserver``
- Pour redémarrer virtualenv les fois suivantes : ``~\.virtualenvs\zdsenv\Scripts\activate.ps1``

Pour faire fonctionner ZdS dans son ensemble vous devez installer les outils LateX et Pandoc.

Expand Down
102 changes: 102 additions & 0 deletions doc/sphinx/source/utils/templatetags.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@

Elements de templates personnalisés
===================================

Le package ``zds/utils/templatetags`` contient un ensemble de tags et filtres personnalisés pouvant être utilisés
dans les templates rendues par Django.

La majorité de ces modules proposent aussi des fonctions proposant les même fonctionnalités depuis le reste du code
Python.

append_to_get
-------------

L'élément ``append_to_get`` permet de rajouter des paramètres à la requête ``GET`` courante. Par exemple, sur une page
``module/toto``, le code de template suivant ::

{% load append_to_get %}
<a href="{% append_to_get page=key1=var1,key2=var2 %}">Mon lien</a>

produira le code suivant ::

<a href="module/toto?key1=1&key2=2">Mon lien</a>

si le contenu de ``var1`` est ``1`` et le contenu de ``var2`` est ``2``

captureas
---------

L'élément ``captureas`` permet de demander d'effectuer le rendu d'un bloc de template et de stocker son contenu dans
une variable. Ainsi le code suivant ::

{% load captureas %}
{% captureas var2 %}
{% for i in 'xxxxxxxxxx' %}
{{forloop.counter0}}
{% endfor %}
{% endcaptureas %}

ne produit rien en sortie mais affecte le résultat du bloc entre les éléments ``{% captureas var2 %}`` et
``{% endcaptureas %}``, soit ``0123456789``, dans la variable de template ``var2``

date
----

Plusieurs filtres sont disponible dans ce module.

format_date
+++++++++++

Ce filtre formate une date au format ``DateTime`` destiné à être affiché sur le site::

{% load date %}
{{ date | format_date}}

tooltip_date
++++++++++++

Ce filtre effectue la même chose que ``format_date`` mais à destination des ``tooltip``.

humane_time
+++++++++++

Formate une date au format *Nombre de seconde depuis Epoch* en un élément lisible. Ainsi ::

{% load date %}
{{ date_epoch | humane_time}}

sera rendu ::

01 Jan 1970, 01:00:42

Si le contenu de ``date_epoch`` etait de ``42``.

emarkdown
---------

Markdown vers HTML
++++++++++++++++++

Permet de rendre un texte markdown en HTML :

- ``emarkdown`` : Transforamtion classique
- ``emarkdown_inline`` : Transforamtion uniquement des éléments *inline* et donc pas de blocs. Utilisés pour les
signatures des membres.


Markdown vers Markdown
++++++++++++++++++++++

Ces élements sont utilisés dans le cadre de la transformation du markdown avant d'être traité par ``Pandoc`` lors de la
génération des fichiers PDF et EPUB des tutos :

- ``decale_header_1`` : Décale les titres de 1 niveau (un titre de niveau 1 devient un titre de niveau 2, etc.)
- ``decale_header_2`` : Décale les titres de 2 niveaux (un titre de niveau 1 devient un titre de niveau 3, etc.)
- ``decale_header_3`` : Décale les titres de 3 niveaux (un titre de niveau 1 devient un titre de niveau 4, etc.)



autres
------

**TODO**
10 changes: 10 additions & 0 deletions doc/sphinx/source/utils/utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
=============
Autres outils
=============

Le package ``zds/utils`` contient un certains nombres d'outils transverses.

.. toctree::
:maxdepth: 2

templatetags
2 changes: 1 addition & 1 deletion templates/article/member/history.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{% extends "article/base_content.html" %}
{% load emarkdown %}
{% load profile %}
{% load date %}
{% load thumbnail %}
{% load date %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tu charges 2 fois date ici.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

en effet j'ai pas fait gaffe qu'il était déjà chargé,



{% block title %}
Expand Down
2 changes: 1 addition & 1 deletion templates/tutorial/tutorial/history.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends "tutorial/base.html" %}
{% load emarkdown %}
{% load profile %}
{% load thumbnail %}
{% load date %}


{% block title %}
Expand Down