1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/etherpad_mypads_ynh.git synced 2024-09-03 18:36:09 +02:00

Add auto README

This commit is contained in:
ericgaspar 2021-05-25 16:38:45 +02:00
parent fb52ae0019
commit 2a130f279e
No known key found for this signature in database
GPG key ID: 574F281483054D44
3 changed files with 71 additions and 0 deletions

31
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,31 @@
## Configuration
You can access two different admin panels, for Etherpad by accessing `domain.tld/admin` and for MyPads by `domain.tld/mypads/?/admin`.
You can also find a configuration file for Etherpad at this path `/var/www/etherpad_mypads/settings.json`.
*Skin Builder* (accessible at this address `domain.tld/pad/p/test#skinvariantsbuilder`) allows you to customize the skin of your pad. It will give you a parameter to copy into your configuration file `/var/www/etherpad_mypads/settings.json`.
## YunoHost specific features
#### Multi-users support
* Is LDAP auth supported (for MyPads access only)? **Yes**
* Can the app be used by multiple users? **Yes**
## Additionnal informations
* This package will install the following plugins:
* [ep_align](https://www.npmjs.com/package/ep_align) - *Add Left/Center/Right/Justify to lines of text in a pad*
* [ep_author_hover](https://www.npmjs.com/package/ep_author_hover) - *Adds author names to span titles*
* [ep_comments_page](https://www.npmjs.com/package/ep_comments_page) - *Adds comments on sidebar and link it to the text.*
* [ep_countable](https://www.npmjs.com/package/ep_countable) - *Adds paragraphs, words and characters count*
* [ep_delete_empty_pads](https://www.npmjs.com/package/ep_delete_empty_pads) - *Delete pads which were never edited*
* [ep_font_color](https://www.npmjs.com/package/ep_font_color) - *Apply colors to fonts*
* [ep_font_size](https://www.npmjs.com/package/ep_font_size) - *Add support for Font Sizes*
* [ep_headings2](https://www.npmjs.com/package/ep_headings2) - *Adds heading support to Etherpad Lite.*
* [ep_markdown](https://www.npmjs.com/package/ep_markdown) - *Edit and Export as Markdown in Etherpad*
* [ep_mypads](https://www.npmjs.com/package/ep_mypads) - *Groups and private pads for etherpad*
* [ep_spellcheck](https://www.npmjs.com/package/ep_spellcheck) - *Add support to do 'Spell checking'*
* [ep_subscript_and_superscript](https://www.npmjs.com/package/ep_subscript_and_superscript) - *Add support for Subscript and Superscript*
* [ep_table_of_contents](https://www.npmjs.com/package/ep_table_of_contents) - *View a table of contents for your pad*

32
doc/DISCLAIMER_fr.md Normal file
View file

@ -0,0 +1,32 @@
## Configuration
Vous pouvez accéder à deux panneaux d'administration différents, pour Etherpad en accédant à `domain.tld/admin` et pour MyPads par `domain.tld/mypads/?/admin`. Vous pouvez également trouver le fichier de configuration pour Etherpad à `/var/www/etherpad_mypads/settings.json`.
*Skin Builder* (accessible à cette adresse `domain.tld/pad/p/test#skinvariantsbuilder`) vous permet de personnaliser l'apparence de votre pad. Il vous donnera un paramètre à copier dans votre fichier de configuration `/var/www/etherpad_mypads/settings.json`.
## Fonctionnalités spécifiques à YunoHost
#### Support multi-utilisateurs
* L'authentification LDAP est-elle prise en charge (pour l'accès MyPads uniquement) ? **Oui**
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
## Limitations
## Informations additionnelles
* Ce paquet installera les plugins suivants :
* [ep_align](https://www.npmjs.com/package/ep_align) - *Ajoute Gauche/Centre/Droite/Justifier à des lignes de texte dans un pad*
* [ep_author_hover](https://www.npmjs.com/package/ep_author_hover) - *Ajoute des noms d'auteurs*
* [ep_comments_page](https://www.npmjs.com/package/ep_comments_page) - *Ajoute des commentaires sur la sidebar et le lie au texte.*
* [ep_countable](https://www.npmjs.com/package/ep_countable) - *Ajoute l'afficher le nombre de paragraphes, de mots et de caractères*
* [ep_delete_empty_pads](https://www.npmjs.com/package/ep_delete_empty_pads) - *Supprimer les pads qui n'ont jamais été édités*
* [ep_font_color](https://www.npmjs.com/package/ep_font_color) - *Appliquer les couleurs aux polices de caractères*
* [ep_font_size](https://www.npmjs.com/package/ep_font_size) - *Permet de définir la taille de la police*.
* [ep_headings2](https://www.npmjs.com/package/ep_headings2) - *Ajoute le support de titre à Etherpad Lite.*
* [ep_markdown](https://www.npmjs.com/package/ep_markdown) - *Modifier et exporter en tant que Markdown dans Etherpad*
* [ep_mypads](https://www.npmjs.com/package/ep_mypads) - *Groupes et pads privés pour etherpad*
* [ep_spellcheck](https://www.npmjs.com/package/ep_spellcheck) - *Ajouter le support pour faire de la vérification orthographique*
* [ep_subscript_and_superscript](https://www.npmjs.com/package/ep_subscript_and_superscript) - *Ajouter la prise en charge de Subscript et Superscript*.
* [ep_table_of_contents](https://www.npmjs.com/package/ep_table_of_contents) - *Voir une table des matières pour votre pad*

View file

@ -8,6 +8,14 @@
}, },
"version": "1.8.13~ynh2", "version": "1.8.13~ynh2",
"url": "https://framapad.org", "url": "https://framapad.org",
"upstream": {
"license": "Apache-2.0",
"website": "http://etherpad.org",
"demo": "https://video.etherpad.com",
"admindoc": "http://etherpad.org/doc/v1.8.13",
"userdoc": "https://yunohost.org/en/app_etherpad_mypads",
"code": "https://github.com/ether/etherpad-lite"
},
"license": "Apache-2.0", "license": "Apache-2.0",
"maintainer": { "maintainer": {
"name": "", "name": "",