From 7aef72bdffced2a4303c3a47dada8aee20b84799 Mon Sep 17 00:00:00 2001 From: Thomas Nonglaton Date: Tue, 31 May 2016 18:04:51 +0200 Subject: [PATCH] Start doc for recursive feature --- docs/configuration.rst | 1 + docs/example.rst | 76 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+) diff --git a/docs/configuration.rst b/docs/configuration.rst index f1fdc5e..bfb516d 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -8,6 +8,7 @@ The files organisation is quite simple: * in the root directory of your project you need a settings.yaml file that will contains the title and subtitle of your gallery * for each gallery you'll need a folder that also contains a settings.yaml file that will describe how to display the content on your gallery * and you put the pictures of the gallery inside the gallery folder + * or other directory, in the gallery became an index (so pictures won't be display, only cover of child gallery) Root settings.yaml ------------------ diff --git a/docs/example.rst b/docs/example.rst index bcecec9..4a0ff36 100644 --- a/docs/example.rst +++ b/docs/example.rst @@ -42,3 +42,79 @@ The content of ``example/first_gallery/settings.yaml``:: - stuff.png - type: full-picture image: stuff.png + +The content of ``example/second_gallery/settings.yaml``:: + + title: my second level gallery + sub_title: some subtitle + date: 2015-12-08 + cover: stuff.png + +The content of ``example/second_gallery/second_level_gallery_2/settings.yaml``:: + + title: my second level gallery 2 + sub_title: some subtitle + date: 2015-12-08 + cover: stuff.png + sections: + - type: full-picture + image: stuff.png + text: + title: Beautiful Title + sub_title: pouet pouet + date: 2015-12-08 + - type: full-picture + image: + name: video.mp4 + type: video + text: + title: Beautiful Title + sub_title: pouet pouet + date: 2015-12-08 + - type: bordered-picture + image: + name: video.mp4 + type: video + - type: bordered-picture + image: stuff.png + - type: bordered-picture + image: + name: video.mp4 + type: video + text: "plop" + - type: bordered-picture + image: stuff.png + text: "plop" + - type: text + text: « voici plein de blabla à rajouter et ceci est du gras et encore plein plein plein plein de text car je veux voir comment ça va wrapper car c'est important et il faut pas que j'oublie de mettre des margins en % sinon ça va pas le faire alala là ça devrait aller » + - type: pictures-group + images: + - + - name: stuff.png + text: "test" + - name: video.mp4 + type: video + - name: stuff.png + text: "test" + - + - stuff.png + - name: video.mp4 + type: video + - type: pictures-group + images: + - + - name: stuff.png + text: "test" + - name: stuff.png + text: "test" + - name: stuff.png + text: "test" + - + - stuff.png + - stuff.png + - type: full-picture + image: stuff.png + - type: full-picture + image: + name: video.mp4 + type: video