aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/en/developer/api.rst24
-rw-r--r--docs/en/developer/translate.rst10
-rw-r--r--docs/fr/developer/translate.rst10
3 files changed, 34 insertions, 10 deletions
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst
index ac00d3a4..38f0377c 100644
--- a/docs/en/developer/api.rst
+++ b/docs/en/developer/api.rst
@@ -69,6 +69,12 @@ You'll have this in return:
69 69
70We'll work with the ``access_token`` value in our next calls. 70We'll work with the ``access_token`` value in our next calls.
71 71
72Curl example:
73
74::
75
76 curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag"
77
72Getting existing entries 78Getting existing entries
73------------------------ 79------------------------
74 80
@@ -120,6 +126,12 @@ returns:
120 126
121The ``items`` array is empty. 127The ``items`` array is empty.
122 128
129Curl example:
130
131::
132
133 curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
134
123Adding your first entry 135Adding your first entry
124----------------------- 136-----------------------
125 137
@@ -174,6 +186,12 @@ returns
174 186
175Now, if you execute the previous command (see **Get existing entries**), you'll have data. 187Now, if you execute the previous command (see **Get existing entries**), you'll have data.
176 188
189Curl example:
190
191::
192
193 curl "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA&url=http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html"
194
177Deleting an entry 195Deleting an entry
178----------------- 196-----------------
179 197
@@ -227,6 +245,12 @@ returns
227 245
228And if you want to list the existing entries (see **Get existing entries**), the array is empty. 246And if you want to list the existing entries (see **Get existing entries**), the array is empty.
229 247
248Curl example:
249
250::
251
252 curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
253
230Other methods 254Other methods
231------------- 255-------------
232 256
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst
index 39478fd5..f1a12adf 100644
--- a/docs/en/developer/translate.rst
+++ b/docs/en/developer/translate.rst
@@ -12,15 +12,15 @@ Translation files
12 As wallabag is mainly developed by a French team, please consider that french 12 As wallabag is mainly developed by a French team, please consider that french
13 translation is the most updated one and please copy it to create your own translation. 13 translation is the most updated one and please copy it to create your own translation.
14 14
15You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. 15You can find translation files here: https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations.
16 16
17You have to create ``messages.CODE.yml``, where CODE 17You have to create ``messages.CODE.yml``, where CODE
18is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__). 18is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).
19 19
20Other files to translate: 20Other files to translate:
21 21
22- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations. 22- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
23- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations. 23- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations.
24 24
25You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. 25You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files.
26 26
@@ -28,7 +28,7 @@ Configuration file
28~~~~~~~~~~~~~~~~~~ 28~~~~~~~~~~~~~~~~~~
29 29
30You have to edit `app/config/config.yml 30You have to edit `app/config/config.yml
31<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ to display 31<https://github.com/wallabag/wallabag/blob/master/app/config/config.yml>`__ to display
32your language on Configuration page of wallabag (to allow users to switch to this new translation). 32your language on Configuration page of wallabag (to allow users to switch to this new translation).
33 33
34Under the ``wallabag_core.languages`` section, you have to add a new line with 34Under the ``wallabag_core.languages`` section, you have to add a new line with
@@ -55,6 +55,6 @@ wallabag documentation
55 55
56 Contrary to the web application, the main language for documentation is english. 56 Contrary to the web application, the main language for documentation is english.
57 57
58Documentation files are stored here: https://github.com/wallabag/wallabag/tree/v2/docs 58Documentation files are stored here: https://github.com/wallabag/wallabag/tree/master/docs
59 59
60You need to respect the ``en`` folder structure when you create your own translation. 60You need to respect the ``en`` folder structure when you create your own translation.
diff --git a/docs/fr/developer/translate.rst b/docs/fr/developer/translate.rst
index 410aafe6..cc5336ee 100644
--- a/docs/fr/developer/translate.rst
+++ b/docs/fr/developer/translate.rst
@@ -13,15 +13,15 @@ Fichiers de traductions
13 cette traduction qui est considérée comme la plus récente. Merci de vous baser 13 cette traduction qui est considérée comme la plus récente. Merci de vous baser
14 sur celle-ci pour créer votre traduction. 14 sur celle-ci pour créer votre traduction.
15 15
16Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. 16Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations.
17 17
18Vous devez créer le fichier ``messages.CODE.yml``, 18Vous devez créer le fichier ``messages.CODE.yml``,
19où CODE est le code ISO 639-1 de votre langue (`cf wikipedia <https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1>`__). 19où CODE est le code ISO 639-1 de votre langue (`cf wikipedia <https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1>`__).
20 20
21Autres fichiers à traduire : 21Autres fichiers à traduire :
22 22
23- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations. 23- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
24- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations. 24- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations.
25 25
26Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``. 26Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``.
27 27
@@ -29,7 +29,7 @@ Fichier de configuration
29~~~~~~~~~~~~~~~~~~~~~~~~ 29~~~~~~~~~~~~~~~~~~~~~~~~
30 30
31Vous devez éditer `app/config/config.yml 31Vous devez éditer `app/config/config.yml
32<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ pour 32<https://github.com/wallabag/wallabag/blob/master/app/config/config.yml>`__ pour
33afficher votre langue dans la page Configuration de wallabag (pour permettre aux 33afficher votre langue dans la page Configuration de wallabag (pour permettre aux
34utilisateurs de choisir cette nouvelle traduction). 34utilisateurs de choisir cette nouvelle traduction).
35 35
@@ -57,6 +57,6 @@ Documentation de wallabag
57 57
58 Contrairement à l'application, la langue principale de la documentation est l'anglais 58 Contrairement à l'application, la langue principale de la documentation est l'anglais
59 59
60Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/v2/docs 60Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/master/docs
61 61
62Vous devez respecter la structure du dossier ``en`` quand vous crééz votre traduction. 62Vous devez respecter la structure du dossier ``en`` quand vous crééz votre traduction.