From 7720cca5325eae71595e6355d6599448c30377fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 23 Feb 2016 11:32:48 +0100 Subject: Add annotator in baggy theme + Documentation about annotations --- docs/en/index.rst | 1 + docs/en/user/annotations.rst | 24 ++++++++++++++++++++++++ docs/fr/index.rst | 1 + docs/fr/user/annotations.rst | 25 +++++++++++++++++++++++++ docs/img/user/annotations_1.png | Bin 0 -> 34930 bytes docs/img/user/annotations_2.png | Bin 0 -> 28142 bytes docs/img/user/annotations_3.png | Bin 0 -> 27277 bytes 7 files changed, 51 insertions(+) create mode 100644 docs/en/user/annotations.rst create mode 100644 docs/fr/user/annotations.rst create mode 100644 docs/img/user/annotations_1.png create mode 100644 docs/img/user/annotations_2.png create mode 100644 docs/img/user/annotations_3.png (limited to 'docs') diff --git a/docs/en/index.rst b/docs/en/index.rst index ab58ca6b..54d79e0c 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -29,6 +29,7 @@ The main documentation for this application is organized into a couple sections: user/configuration user/first_article user/errors_during_fetching + user/annotations user/import user/download_articles user/filters diff --git a/docs/en/user/annotations.rst b/docs/en/user/annotations.rst new file mode 100644 index 00000000..d30b2c52 --- /dev/null +++ b/docs/en/user/annotations.rst @@ -0,0 +1,24 @@ +Annotations +=========== + +In each article you read, you can write annotations. It's easier to understand with some pictures. + +Select the part of the article that you want to comment and click on the pencil: + +.. image:: ../../img/user/annotations_1.png + :alt: Select your text + :align: center + +Then, write your comment: + +.. image:: ../../img/user/annotations_2.png + :alt: Write your comment + :align: center + +The text is now highlighted and you can read your comment if you move the mouse cursor over it. + +.. image:: ../../img/user/annotations_3.png + :alt: Read your comment + :align: center + +You can create as many comments as you wish. diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 5adc5ab5..48310680 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -30,6 +30,7 @@ La documentation principale de cette application est découpée en plusieurs sec user/configuration user/first_article user/errors_during_fetching + user/annotations user/import user/download_articles user/filters diff --git a/docs/fr/user/annotations.rst b/docs/fr/user/annotations.rst new file mode 100644 index 00000000..8ba87e26 --- /dev/null +++ b/docs/fr/user/annotations.rst @@ -0,0 +1,25 @@ +Commentaires +============ + +Sur chaque article que vous lisez, vous pouvez écrire des commentaires. Puisqu'une image vaut mieux qu'un long discours, +voici ce que ça donne. + +Sélectionnez la zone du texte que vous souhaitez commenter et cliquez sur le crayon : + +.. image:: ../../img/user/annotations_1.png + :alt: Select your text + :align: center + +Ensuite, écrivez votre commentaire : + +.. image:: ../../img/user/annotations_2.png + :alt: Write your comment + :align: center + +Le texte est maintenant surligné et vous pouvez lire le commentaire en le survolant avec votre souris. + +.. image:: ../../img/user/annotations_3.png + :alt: Read your comment + :align: center + +Vous pouvez créer autant de commentaires que vous le souhaitez. diff --git a/docs/img/user/annotations_1.png b/docs/img/user/annotations_1.png new file mode 100644 index 00000000..554282f5 Binary files /dev/null and b/docs/img/user/annotations_1.png differ diff --git a/docs/img/user/annotations_2.png b/docs/img/user/annotations_2.png new file mode 100644 index 00000000..5351d2c5 Binary files /dev/null and b/docs/img/user/annotations_2.png differ diff --git a/docs/img/user/annotations_3.png b/docs/img/user/annotations_3.png new file mode 100644 index 00000000..bc371ec3 Binary files /dev/null and b/docs/img/user/annotations_3.png differ -- cgit v1.2.3