Merge pull request #12621 from frederic34/markdown

clean markdown

README-FR.md

@@ -1,18 +1,14 @@
 # DOLIBARR ERP & CRM
 
-Dolibarr ERP & CRM est un logiciel moderne pour gérer votre activité (société, association, auto-entrepreneurs, artisans). 
+Dolibarr ERP & CRM est un logiciel moderne pour gérer votre activité (société, association, auto-entrepreneurs, artisans).
 Il est simple d'utilisation et modulaire, vous permettant de n'activez que les fonctions dont vous avez besoin (contacts, fournisseurs, factures, commandes, stocks, agenda, ...).
- 
+
 ![ScreenShot](https://www.dolibarr.org/images/dolibarr_screenshot1_640x480.png)
 
-
-
 ## LICENCE
 
 Dolibarr est distribué sous les termes de la licence GNU General Public License v3+ ou supérieure.
 
-
-
 ## INSTALLER DOLIBARR
 
 ### Configuration simple
@@ -23,7 +19,7 @@ Si vous avez peu de compétences techniques et que vous souhaitez installer Doli
 - DoliDeb pour Debian ou Ubuntu
 - DoliRpm pour Redhat, Fedora, OpenSuse, Mandriva ou Mageia
 
-Les packages peuvent être téléchargés à partir de [site web officiel] (https://www.dolibarr.org/).
+Les packages peuvent être téléchargés à partir de [site web officiel](https://www.dolibarr.org/).
 
 ### Configuration avancée
 
@@ -31,50 +27,47 @@ Vous pouvez aussi utiliser un serveur Web et une base de données prise en charg
 
 - Décompressez l'archive .zip téléchargée pour copier le répertoire "dolibarr/htdocs" et tous ses fichiers à la racine du serveur Web ou récupérez-les directement à partir de GitHub (recommandé si vous connaissez git):
 
-  git clone https://github.com/dolibarr/dolibarr -b x.y   (où x.y est la version principale comme 3.6, 9.0, ...)
+  `git clone https://github.com/dolibarr/dolibarr -b x.y`   (où x.y est la version principale comme 3.6, 9.0, ...)
 
 - Configurez votre serveur Web pour qu'il utilise "*dolibarr/htdocs*" en tant que racine si votre serveur Web ne possède pas déjà de répertoire défini vers lequel pointer.
- 
+
 - Créez un fichier `htdocs/conf/conf.php` vide et définissez les autorisations d'*écrire* pour l'utilisateur de votre serveur Web (l'autorisation *écrire* sera supprimée une fois l'installation terminée)
 
 - Depuis votre navigateur, allez à la page "install/" de dolibarr
 
-    L’URL dépendra de la façon dont votre configuration Web a été configurée pour pointer vers votre installation de dolibarr. Cela peut ressembler à:
+  L’URL dépendra de la façon dont votre configuration Web a été configurée pour pointer vers votre installation de dolibarr. Cela peut ressembler à:
+
+  `http://localhost/dolibarr/htdocs/install/`
+
+  ou
+
+  `http://localhost/dolibarr/install/`
+
+  ou
+
+  `http://yourdolibarrvirtualhost/install/`
 
-        http://localhost/dolibarr/htdocs/install/
-        
-    ou
-    
-        http://localhost/dolibarr/install/
-        
-    ou
-    
-    http://yourdolibarrvirtualhost/install/
-   
 - Suivez les instructions de l'installateur
 
-
 ## METTRE A JOUR DOLIBARR
 
 Pour mettre à jour Dolibarr depuis une vieille version vers celle ci:
+
 - Ecrasez les vieux fichiers dans le vieux répertoire 'dolibarr' par les fichiers
   fournis dans ce nouveau package.
-  
+
 - Au prochain accès, Dolibarr proposera la page de "mise à jour" des données (si nécessaire).
-  Si un fichier install.lock existe pour verrouiller le processus de mise à jour, il sera demandé de le supprimer manuellement (vous devriez trouver le fichier install.lock dans le répertoire utilisé pour stocker les documents générés ou transférés sur le serveur. Dans la plupart des cas, c'est le répertoire appelé "documents") 
+  Si un fichier install.lock existe pour verrouiller le processus de mise à jour, il sera demandé de le supprimer manuellement (vous devriez trouver le fichier install.lock dans le répertoire utilisé pour stocker les documents générés ou transférés sur le serveur. Dans la plupart des cas, c'est le répertoire appelé "documents")
-  
+
 *Note: Le processus de migration peut être lancé manuellement et plusieurs fois, sans risque, en appelant la page /install/*
-  
 
 ## CE QUI EST NOUVEAU
 
 Voir fichier ChangeLog.
 
-
-
 ## CE QUE DOLIBARR PEUT FAIRE
 
-### Modules principaux (tous optionnels):
+### Modules principaux (tous optionnels)
 
 - Annuaires des prospects et/ou client et/ou fournisseurs
 - Gestion de catalogue de produits et services
@@ -83,7 +76,7 @@ Voir fichier ChangeLog.
 - Gestion des factures clients/fournisseurs et paiements
 - Gestion des virements bancaires SEPA
 - Gestion des comptes bancaires
-- Calendrier/Agenda partagé (avec export ical, vcal) 
+- Calendrier/Agenda partagé (avec export ical, vcal)
 - Suivi des opportunités et/ou projets (suivi de rentabilité incluant les factures, notes de frais, temps consommé valorisé, ...)
 - Gestion de contrats de services
 - Gestion de stock
@@ -96,7 +89,7 @@ Voir fichier ChangeLog.
 - Point de vente/Caisse enregistreuse
 - …
 
-### Autres modules:
+### Autres modules
 
 - Gestion de marque-pages
 - Gestion des promesses de dons
@@ -111,7 +104,7 @@ Voir fichier ChangeLog.
 - Intégration de système de paiements (Paypal, Stripe, Paybox...)
 - …
 
-### Divers:
+### Divers
 
 - Multi-langue.
 - Multi-utilisateurs avec différents niveaux de permissions par module.
@@ -119,61 +112,57 @@ Voir fichier ChangeLog.
 - Peux être multi-société par ajout du module externe multi-société.
 - Plusieurs thèmes visuels.
 - Application simple à utiliser.
-- Requiert PHP et MariaDb, Mysql ou Postgresql (Voir versions exactes sur https://wiki.dolibarr.org/index.php/Prérequis). 
+- Requiert PHP et MariaDb, Mysql ou Postgresql (Voir versions exactes sur https://wiki.dolibarr.org/index.php/Prérequis).
 - Compatible avec toutes les offres Cloud du marché respectant les prérequis de base de données et PHP.
 - APIs.
 - Génération PDF et ODT des éléments (factures, propositions commerciales, commandes, bons expéditions, etc...)
 - Code simple et facilement personnalisable (pas de framework lourd; mécanisme de hook et triggers).
 - Support natif de nombreuses fonctions spécifiques aux pays comme:
-	- La tax espagnole TE et ISPF
+  - La tax espagnole TE et ISPF
-	- Gestion de la TVA NPR (non perçue récupérable - pour les utilisateurs français des DOM-TOM)
+  - Gestion de la TVA NPR (non perçue récupérable - pour les utilisateurs français des DOM-TOM)
-	- La loi française Finance 2016 et logiciels de caisse
+  - La loi française Finance 2016 et logiciels de caisse
-	- La double taxe canadienne
+  - La double taxe canadienne
-	- Le timbre fiscal tunisien
+  - Le timbre fiscal tunisien
-	- Numérotation de facture de l'argentines (avec type A,B,C...) 
+  - Numérotation de facture de l'argentines (avec type A,B,C...)
-	- Compatible avec vos processus RGPD 
+  - Compatible avec vos processus RGPD
-	- ...
+  - ...
 - …
 
 ### Extension
 
 Dolibarr peut aussi être étendu à volonté avec l'ajout de module/applications externes développées par des développeus tiers, disponible sur [DoliStore](https://www.dolistore.com).
 
-
 ## CE QUE DOLIBARR NE PEUT PAS (ENCORE) FAIRE
 
 Voici un liste de fonctionnalités pas encore gérées par Dolibarr:
+
 - Dolibarr ne contient pas de module de Gestion de la paie.
 - Les tâches du module de gestion de projets n'ont pas de dépendances entre elle.
 - Dolibarr n'embarque pas de Webmail intégré nativement.
-- Dolibarr ne fait pas le café (pas encore). 
+- Dolibarr ne fait pas le café (pas encore).
-
 
 ## DOCUMENTATION
 
 La documentation utilisateur, développeur et traducteur est disponible sous forme de ressources de la communauté via le site [Wiki](https://wiki.dolibarr.org).
 
-
 ## CONTRIBUER
 
 Ce projet existe grâce à ses nombreux contributeurs [[Contribuer](https://github.com/Dolibarr/dolibarr/blob/develop/.github/CONTRIBUTING.md)].
 <a href="https://github.com/Dolibarr/dolibarr/graphs/contributors"><img src="https://opencollective.com/dolibarr/contributors.svg?width=890&button=false" /></a>
 
-
 ## CREDITS
 
 Dolibarr est le résultat du travail de nombreux contributeurs depuis des années et utilise des librairies d'autres contributeurs.
 
 Voir le fichier [COPYRIGHT](https://github.com/Dolibarr/dolibarr/blob/develop/COPYRIGHT)
 
-
 ## ACTUALITES ET RESEAUX SOCIAUX
 
 Suivez le projet Dolibarr project sur les réseaux francophones
 
-- Facebook: <https://www.facebook.com/dolibarr.fr>
+- [Facebook](https://www.facebook.com/dolibarr.fr)
-- Google+: <https://plus.google.com/+DolibarrFrance>
+- [Google+](https://plus.google.com/+DolibarrFrance)
-- Twitter: <https://www.twitter.com/dolibarr_france>
+- [Twitter](https://www.twitter.com/dolibarr_france)
 
 ou sur les réseaux anglophones
 

README.md

@@ -16,7 +16,6 @@ You can use it as a standalone application or as a web application to be able to
 
 ![ScreenShot](https://www.dolibarr.org/images/dolibarr_screenshot1_640x400.png)
 
-
 ## LICENSE
 
 Dolibarr is released under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version (GPL-3+).
@@ -25,7 +24,6 @@ See the [COPYING](https://github.com/Dolibarr/dolibarr/blob/develop/COPYING) fil
 
 Other licenses apply for some included dependencies. See [COPYRIGHT](https://github.com/Dolibarr/dolibarr/blob/develop/COPYRIGHT) for a full list.
 
-
 ## INSTALLING
 
 ### Simple setup
@@ -42,51 +40,47 @@ Releases can be downloaded from [official website](https://www.dolibarr.org/).
 
 You can use a Web server and a supported database (MariaDB, MySQL or PostgreSQL) to install the standard version.
 
-- Uncompress the downloaded .zip archive to copy the "dolibarr/htdocs" directory and all its files inside your web server root or get the files directly from GitHub (recommanded if you known git): 
+- Uncompress the downloaded .zip archive to copy the "dolibarr/htdocs" directory and all its files inside your web server root or get the files directly from GitHub (recommanded if you known git):
 
-  git clone https://github.com/dolibarr/dolibarr -b x.y     (where x.y is main version like 3.6, 9.0, ...)
+  `git clone https://github.com/dolibarr/dolibarr -b x.y`     (where x.y is main version like 3.6, 9.0, ...)
+
+- Set up your web server to use "*dolibarr/htdocs*" as root if your web server does not have an already defined directory to point to.
 
-- Set up your web server to use "*dolibarr/htdocs*" as root if your web server does not have an already defined directory to point to. 
- 
 - Create an empty `htdocs/conf/conf.php` file and set *write* permissions for your web server user (*write* permission will be removed once install is finished)
 
 - From your browser, go to the dolibarr "install/" page
 
-    The URL will depends on how you web setup was setup to point to your dolibarr installation. It may looks like:
+  The URL will depends on how you web setup was setup to point to your dolibarr installation. It may looks like:
+
+  `http://localhost/dolibarr/htdocs/install/`
+
+  or
+
+  `http://localhost/dolibarr/install/`
+
+  or
+
+  `http://yourdolibarrvirtualhost/install/`
 
-        http://localhost/dolibarr/htdocs/install/
-        
-    or
-    
-        http://localhost/dolibarr/install/
-        
-    or
-    
-    	http://yourdolibarrvirtualhost/install/
-   
 - Follow the installer instructions
 
 ### Saas/Cloud setup
 
 If you don't have time to install it yourself, you can try some commercial 'ready to use' Cloud offers (See https://saas.dolibarr.org). However, this third solution is not free.
 
-
-
 ## UPGRADING
 
-- At first make a backup of your Dolibarr files & than see https://wiki.dolibarr.org/index.php/Installation_-_Upgrade#Upgrade_Dolibarr 
+- At first make a backup of your Dolibarr files & than see https://wiki.dolibarr.org/index.php/Installation_-_Upgrade#Upgrade_Dolibarr
 - Overwrite all old files from 'dolibarr' directory with files provided into the new version's package.
 - At first next access, Dolibarr will redirect your to the "install/" page to follow the upgrade process.
   If an `install.lock` file exists to lock any other upgrade process, the application will ask you to remove the file manually (you should find the `install.lock` file into the directory used to store generated and uploaded documents, in most cases, it is the directory called "*documents*").
 
 *Note: migration process can be safely done multiple times by calling the `/install/index.php` page*
 
-
 ## WHAT'S NEW
 
 See the [ChangeLog](https://github.com/Dolibarr/dolibarr/blob/develop/ChangeLog) file.
 
-
 ## FEATURES
 
 ### Main application/modules (all optional)
@@ -113,7 +107,7 @@ See the [ChangeLog](https://github.com/Dolibarr/dolibarr/blob/develop/ChangeLog)
 - Foundations members management
 - Mass emailing
 - Surveys
-- Point of Sale (POS) 
+- Point of Sale (POS)
 - …
 
 ### Other application/modules
@@ -144,14 +138,14 @@ See the [ChangeLog](https://github.com/Dolibarr/dolibarr/blob/develop/ChangeLog)
 - APIs
 - An easy to understand, maintain and develop code (PHP with no heavy framework; trigger and hook architecture)
 - Support a lot of country specific features:
-    - Spanish Tax RE and ISPF
+  - Spanish Tax RE and ISPF
-    - French NPR VAT rate (VAT called "Non Perçue Récupérable" for DOM-TOM)
+  - French NPR VAT rate (VAT called "Non Perçue Récupérable" for DOM-TOM)
-    - Canadian double taxes (federal/province) and other countries using cumulative VAT
+  - Canadian double taxes (federal/province) and other countries using cumulative VAT
-    - Tunisian tax stamp
+  - Tunisian tax stamp
-    - Argentina invoice numbering using A,B,C... 
+  - Argentina invoice numbering using A,B,C...
-    - Compatible with [European directives](http://europa.eu/legislation_summaries/taxation/l31057_en.htm) (2006/112/CE ... 2010/45/UE)
+  - Compatible with [European directives](http://europa.eu/legislation_summaries/taxation/l31057_en.htm) (2006/112/CE ... 2010/45/UE)
-    - Compatible with European GDPR rules
+  - Compatible with European GDPR rules
-    - ...
+  - ...
 - PDF or ODT generation for invoice, proposals, orders...
 - …
 
@@ -160,12 +154,10 @@ See the [ChangeLog](https://github.com/Dolibarr/dolibarr/blob/develop/ChangeLog)
 - Works with PHP 5.5+ and MariaDB 5.0.3+, MySQL 5.0.3+ or PostgreSQL 8.1.4+ (See requirements on the [Wiki](https://wiki.dolibarr.org/index.php/Prerequisite))
 - Compatible with all Cloud solutions that match MySQL, PHP or PostgreSQL prerequisites.
 
-
 ### Extending
 
 Dolibarr can be extended with a lot of other external application or modules from third party developers available at the [DoliStore](https://www.dolistore.com).
 
-
 ## WHAT DOLIBARR CAN'T DO YET
 
 These are features that Dolibarr does **not** yet fully support:
@@ -175,25 +167,21 @@ These are features that Dolibarr does **not** yet fully support:
 - No native embedded Webmail
 - Dolibarr can't do coffee (yet)
 
-
 ## DOCUMENTATION
 
 Administrator, user, developer and translator's documentations are available along with other community resources on the [Wiki](https://wiki.dolibarr.org).
 
-
 ## CONTRIBUTING
 
 This project exists thanks to all the people who contribute. [[Contribute](https://github.com/Dolibarr/dolibarr/blob/develop/.github/CONTRIBUTING.md)].
 <a href="https://github.com/Dolibarr/dolibarr/graphs/contributors"><img src="https://opencollective.com/dolibarr/contributors.svg?width=890&button=false" /></a>
 
-
 ## CREDITS
 
 Dolibarr is the work of many contributors over the years and uses some fine libraries.
 
 See [COPYRIGHT](https://github.com/Dolibarr/dolibarr/blob/develop/COPYRIGHT) file.
 
-
 ## NEWS AND SOCIAL NETWORKS
 
 Follow Dolibarr project on:
@@ -205,7 +193,6 @@ Follow Dolibarr project on:
 - [YouTube](https://www.youtube.com/user/DolibarrERPCRM)
 - [GitHub](https://github.com/Dolibarr/dolibarr)
 
-
 ### Sponsors
 
 Support this project by becoming a sponsor. Your logo will show up here. 🙏 [[Become a sponsor/backer](https://opencollective.com/dolibarr#backer)]

htdocs/custom/README.md

@@ -1,22 +1,27 @@
-# DOLIBARR ERP & CRM custom directory for external modules.
+# DOLIBARR ERP & CRM custom directory for external modules
 
 This directory is dedicated to store external modules.
 To use it, just copy here the directory of the module into this directory.
 
-Note: On linux or MAC systems, it is better to unzip/store the external module directory into 
+Note: On linux or MAC systems, it is better to unzip/store the external module directory into
 a different place than this directory and just adding a symbolic link here to the htdocs directory
 of the module.
 
-For example on Linux OS: Get the module from the command 
+For example on Linux OS: Get the module from the command
-mkdir ~/git; cd ~/git
+
-git clone https://git.framasoft.org/p/newmodule/newmodule.git
+`mkdir ~/git; cd ~/git`
+
+`git clone https://git.framasoft.org/p/newmodule/newmodule.git`
+
 Then create the symbolic link
-ln -fs ~/git/newmodule/htdocs /path_to_dolibarr/htdocs/custom/newmodule 
+
+`ln -fs ~/git/newmodule/htdocs /path_to_dolibarr/htdocs/custom/newmodule`
 
 WARNING !!!
-Check also that the /custom directory is active by adding into dolibarr conf/conf.php file the following 
+Check also that the /custom directory is active by adding into dolibarr `conf/conf.php` file the following
 two lines, so dolibarr will also scan /custom directory to find external external modules:
 
+```php
 $dolibarr_main_url_root_alt='/custom';
 $dolibarr_main_document_root_alt='/path_to_dolibarr/htdocs/custom/';
-
+```

htdocs/modulebuilder/README.md

@@ -7,9 +7,7 @@ has to offer for module development.
 
 If you don't need to develop your own module/application, you just don't need this.
 
-
+After enabling this module, you should find features to generate or edit modules/application from menu *Home - Admin tools - Module builder*
-After enabling this module, you should find features to generate or edit modules/application from menu *Home - Admin tools - Module builder* 
-
 
 Documentation
 -------------

htdocs/modulebuilder/template/ChangeLog.md

@@ -1,5 +1,5 @@
-# CHANGELOG MYMODULE FOR <a href="https://www.dolibarr.org">DOLIBARR ERP CRM</a>
+# CHANGELOG MYMODULE FOR [DOLIBARR ERP CRM](https://www.dolibarr.org)
 
 ## 1.0
-Initial version
 
+Initial version

htdocs/modulebuilder/template/README.md

@@ -1,29 +1,27 @@
-# MYMODULE FOR <a href="https://www.dolibarr.org">DOLIBARR ERP CRM</a>
+# MYMODULE FOR [DOLIBARR ERP CRM](https://www.dolibarr.org)
 
 ## Features
+
 Description...
 
 <!--
 ![Screenshot mymodule](img/screenshot_mymodule.png?raw=true "MyModule"){imgmd}
 -->
 
-Other modules are available on <a href="https://www.dolistore.com" target="_new">Dolistore.com</a>.
+Other modules are available on [Dolistore.com](https://www.dolistore.com>).
-
-
 
 ## Translations
 
-Translations can be define manually by editing files into directories *langs*. 
+Translations can be define manually by editing files into directories *langs*.
 
 <!--
-This module contains also a sample configuration for Transifex, under the hidden directory [.tx](.tx), so it is possible to manage translation using this service. 
+This module contains also a sample configuration for Transifex, under the hidden directory [.tx](.tx), so it is possible to manage translation using this service.
 
 For more informations, see the [translator's documentation](https://wiki.dolibarr.org/index.php/Translator_documentation).
 
 There is a [Transifex project](https://transifex.com/projects/p/dolibarr-module-template) for this module.
 -->
 
-
 <!--
 
 ## Installation
@@ -33,8 +31,7 @@ There is a [Transifex project](https://transifex.com/projects/p/dolibarr-module-
 - If you get the module in a zip file (like when downloading it from the market place [Dolistore](https://www.dolistore.com)), go into
 menu ```Home - Setup - Modules - Deploy external module``` and upload the zip file.
 
-
+Note: If this screen tell you there is no custom directory, check your setup is correct:
-Note: If this screen tell you there is no custom directory, check your setup is correct: 
 
 - In your Dolibarr installation directory, edit the ```htdocs/conf/conf.php``` file and check that following lines are not commented:
 
@@ -58,7 +55,7 @@ Note: If this screen tell you there is no custom directory, check your setup is
         $dolibarr_main_url_root_alt = '/custom';
         $dolibarr_main_document_root_alt = 'C:/My Web Sites/Dolibarr/htdocs/custom';
         ```
-        
+
 ### From a GIT repository
 
 - Clone the repository in ```$dolibarr_main_document_root_alt/mymodule```
@@ -76,16 +73,14 @@ From your browser:
   - Go to "Setup" -> "Modules"
   - You should now be able to find and enable the module
 
-
 -->
 
-
 ## Licenses
 
-**Main code**
+### Main code
 
 GPLv3 or (at your option) any later version. See file COPYING for more information.
 
-**Documentation**
+### Documentation
 
 All texts and readmes are licensed under GFDL.