Create help section for configuration and #47 #61

baimard · Jan 26, 2022 · 234dc62 · 234dc62
1 parent 8aea4c1
commit 234dc62
Show file tree

Hide file tree

Showing 108 changed files with 101 additions and 46 deletions.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/composer.lock b/composer.lock
diff --git a/js/820.app.js b/js/820.app.js
diff --git a/js/820.devisShow.app.js b/js/820.devisShow.app.js
diff --git a/js/820.factureShow.app.js b/js/820.factureShow.app.js
diff --git a/js/856.app.js b/js/856.app.js
diff --git a/js/856.devisShow.app.js b/js/856.devisShow.app.js
diff --git a/js/856.factureShow.app.js b/js/856.factureShow.app.js
diff --git a/js/client.app.js b/js/client.app.js
diff --git a/js/configuration.app.js b/js/configuration.app.js
diff --git a/js/devis.app.js b/js/devis.app.js
diff --git a/js/devisShow.app.js b/js/devisShow.app.js
diff --git a/js/facture.app.js b/js/facture.app.js
diff --git a/js/factureShow.app.js b/js/factureShow.app.js
diff --git a/js/main.app.js b/js/main.app.js
diff --git a/js/produit.app.js b/js/produit.app.js
diff --git a/js/statistique.app.js b/js/statistique.app.js
diff --git a/l10n/bg.js b/l10n/bg.js
diff --git a/l10n/bg.json b/l10n/bg.json
diff --git a/l10n/cs.js b/l10n/cs.js
diff --git a/l10n/cs.json b/l10n/cs.json
diff --git a/l10n/de.js b/l10n/de.js
diff --git a/l10n/de.json b/l10n/de.json
diff --git a/l10n/de_DE.js b/l10n/de_DE.js
diff --git a/l10n/de_DE.json b/l10n/de_DE.json
diff --git a/l10n/el.js b/l10n/el.js
diff --git a/l10n/el.json b/l10n/el.json
diff --git a/l10n/en_GB.js b/l10n/en_GB.js
diff --git a/l10n/en_GB.json b/l10n/en_GB.json
diff --git a/l10n/es.js b/l10n/es.js
diff --git a/l10n/es.json b/l10n/es.json
diff --git a/l10n/eu.js b/l10n/eu.js
diff --git a/l10n/eu.json b/l10n/eu.json
diff --git a/l10n/fi.js b/l10n/fi.js
diff --git a/l10n/fi.json b/l10n/fi.json
diff --git a/l10n/fr.js b/l10n/fr.js
diff --git a/l10n/fr.json b/l10n/fr.json
diff --git a/l10n/hr.js b/l10n/hr.js
diff --git a/l10n/hr.json b/l10n/hr.json
diff --git a/l10n/hu.js b/l10n/hu.js
diff --git a/l10n/hu.json b/l10n/hu.json
diff --git a/l10n/it.js b/l10n/it.js
diff --git a/l10n/it.json b/l10n/it.json
diff --git a/l10n/ja.js b/l10n/ja.js
diff --git a/l10n/ja.json b/l10n/ja.json
diff --git a/l10n/lt_LT.js b/l10n/lt_LT.js
diff --git a/l10n/lt_LT.json b/l10n/lt_LT.json
diff --git a/l10n/mk.js b/l10n/mk.js
diff --git a/l10n/mk.json b/l10n/mk.json
diff --git a/l10n/nl.js b/l10n/nl.js
diff --git a/l10n/nl.json b/l10n/nl.json
diff --git a/l10n/oc.js b/l10n/oc.js
diff --git a/l10n/oc.json b/l10n/oc.json
diff --git a/l10n/pl.js b/l10n/pl.js
diff --git a/l10n/pl.json b/l10n/pl.json
diff --git a/l10n/pt_BR.js b/l10n/pt_BR.js
diff --git a/l10n/pt_BR.json b/l10n/pt_BR.json
diff --git a/l10n/ru.js b/l10n/ru.js
diff --git a/l10n/ru.json b/l10n/ru.json
diff --git a/l10n/sc.js b/l10n/sc.js
diff --git a/l10n/sc.json b/l10n/sc.json
diff --git a/l10n/sk.js b/l10n/sk.js
diff --git a/l10n/sk.json b/l10n/sk.json
diff --git a/l10n/sl.js b/l10n/sl.js
diff --git a/l10n/sl.json b/l10n/sl.json
diff --git a/l10n/tr.js b/l10n/tr.js
diff --git a/l10n/tr.json b/l10n/tr.json
diff --git a/l10n/zh_CN.js b/l10n/zh_CN.js
diff --git a/l10n/zh_CN.json b/l10n/zh_CN.json
diff --git a/l10n/zh_HK.js b/l10n/zh_HK.js
diff --git a/l10n/zh_HK.json b/l10n/zh_HK.json
diff --git a/l10n/zh_TW.js b/l10n/zh_TW.js
diff --git a/l10n/zh_TW.json b/l10n/zh_TW.json
diff --git a/lib/Db/Bdd.php b/lib/Db/Bdd.php
@@ -173,8 +173,8 @@ public function checkConfig($idNextcloud){
  $this->execSQLNoData($sql, array($this->l->t('Your company name'),
  $this->l->t('Your company contact surname'),
  $this->l->t('Your company contact name'),
- $this->l->t('Your Limited company'),
- $this->l->t('Your company Unique identification'),
+ $this->l->t('Legal company information line one'),
+ $this->l->t('Legal company information line two'),
  $this->l->t('Your company email'),
  $this->l->t('Your company phone'),
  $this->l->t('Your company address'),

diff --git a/src/css/mycss.less b/src/css/mycss.less
@@ -227,4 +227,8 @@ table.dataTable.display tbody tr.even > [class*="sorting_"] {
  float: right;
  padding-top:0px;
  margin-top: 0px;
+}
+
+.ConfigurationHelp{
+ margin-bottom: 20px;
 }
diff --git a/src/js/client.js b/src/js/client.js
diff --git a/src/js/configuration.js b/src/js/configuration.js
@@ -14,8 +14,17 @@ window.addEventListener('DOMContentLoaded', function () {
  configuration(path);
  configuration(loadConfigurationDT);
 
+ /* LISTENER */
+
+ var HelpSection = document.getElementById('HelpSection');
+ HelpSection.addEventListener('click', function(){
+ var modal = document.getElementById("ConfigurationHelp");
+ modal.style.display = "block";
+ });
+
 });
 
+
 function loadConfigurationDT(response) {
  $.each(JSON.parse(response), function (arrayID, myresp) {
  $('#entreprise').html(((myresp.entreprise.length === 0) ? '-' : myresp.entreprise));

diff --git a/src/js/devis.js b/src/js/devis.js
diff --git a/src/js/devisShow.js b/src/js/devisShow.js
diff --git a/src/js/facture.js b/src/js/facture.js
diff --git a/src/js/factureShow.js b/src/js/factureShow.js
diff --git a/src/js/listener/main_listener.js b/src/js/listener/main_listener.js
@@ -1,4 +1,4 @@
-const { FilePicker } = require("@nextcloud/dialogs");
+const { FilePicker, showError } = require("@nextcloud/dialogs");
 const { updateDB, configuration, updateEditable, deleteDB, getProduitsById, listProduit } = require("../modules/ajaxRequest.mjs");
 const { path, baseUrl } = require("../modules/mainFunction.mjs");
 import DataTable from 'datatables.net';

diff --git a/src/js/produit.js b/src/js/produit.js
diff --git a/src/js/statistique.js b/src/js/statistique.js
diff --git a/templates/configuration.php b/templates/configuration.php
@@ -10,6 +10,7 @@
 
  <div id="app-content">
  <div id="app-content-wrapper">
+ <?php print_unescaped($this->inc('content/changelog')); ?>
  <?php print_unescaped($this->inc('content/configuration')); ?>
  </div>
  </div>

diff --git a/templates/content/changelog.php b/templates/content/changelog.php
@@ -30,3 +30,35 @@
  <button id="sendmail"><?php p($l->t('Send')); ?></button>
  </div>
 </div>
+
+<div id="ConfigurationHelp" class="modal">
+ <div class="modal-content">
+ <span class="modalClose">&times;</span>
+ <h2><?php p($l->t('Help configure')); ?></h2>
+ <hr/>
+ <h2><?php p($l->t('Company name')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('This is the name of the company that will appear in the footer of your quote and invoice. For example, you can set : "Company : Cybercorp" or just "Cybercorp"')); ?></div>
+ <h2><?php p($l->t('Your company contact surname')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('First name appear in the quote/invoice header as a contact')); ?></div>
+ <h2><?php p($l->t('Your company contact name')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('Last name appear in the quote/invoice header as a contact')); ?></div>
+ <h2><?php p($l->t('Legal company information line one')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('This is a first line in the footer of your Quote/Invoice with all legals informations you need')); ?></div>
+ <h2><?php p($l->t('Legal company information line two')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('This is a second line in the footer of your Quote/Invoice with all legals informations you need')); ?></div>
+ <h2><?php p($l->t('Your company address')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('Company address appear in the quote/invoice header')); ?></div>
+ <h2><?php p($l->t('Your company phone')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('Phone number appear in the quote/invoice header')); ?></div>
+ <h2><?php p($l->t('Your company email')); ?></h2>
+ <div><?php p($l->t('Email appear in the quote/invoice header')); ?></div>
+ <h2><?php p($l->t('Your company VAT')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('Global Default VAT apply to your Quote/Invoice (globally), to change it, please just insert VAT amount without the percent sign')); ?></div> 
+ <h2><?php p($l->t('Automatic generated invoice number')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('If you want to have an automatic generated invoice number, set to enable, if you want to be free, set disable. You can enable and disable when you want.')); ?></div> 
+ <h2><?php p($l->t('Global default Currency')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('Gloabl currency for the application')); ?></div>
+ <h2><?php p($l->t('Legal disclaimer/mentions')); ?></h2>
+ <div class="ConfigurationHelp"><?php p($l->t('Legal disclaimer/mentions you need in your footer - before company information')); ?></div>
+ </div>
+</div>
diff --git a/templates/content/configuration.php b/templates/content/configuration.php
@@ -8,53 +8,53 @@
  <span><?php p($l->t('Configuration')); ?></span>
  </div>
  </div>
- <h2 id="configuration"><?php p($l->t('Click to edit')); ?></h2>
- <div title="<?php p($l->t('Company name')); ?>" class="configuration-global">
- <div class="configuration-icon icon-timezone"></div>
+ <h2 id="configuration"><?php p($l->t('Click to edit')); ?> - <a id="HelpSection"><u><?php p($l->t('Need help ?')); ?></u></a></h2>
+ <div title="<?php p($l->t('This is the name of the company that will appear in the footer of your quote and invoice. For example, you can set : "Company : Cybercorp" or just "Cybercorp"')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="entreprise" class="configuration-content editable" data-table="configuration" data-column="entreprise" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Contact First name')); ?>" class="configuration-global">
- <div class="configuration-icon icon-user"></div>
+ <div title="<?php p($l->t('First name appear in the quote/invoice header as a contact')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="prenom" class="configuration-content editable" data-table="configuration" data-column="prenom" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Contact name')); ?>" class="configuration-global">
- <div class="configuration-icon icon-user"></div>
+ <div title="<?php p($l->t('Last name appear in the quote/invoice header as a contact')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="nom" class="configuration-content editable" data-table="configuration" data-column="nom" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Company address')); ?>" class="configuration-global">
- <div class="configuration-icon icon-address"></div>
+ <div title="<?php p($l->t('Company address appear in the quote/invoice header')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="adresse" class="configuration-content editable" data-table="configuration" data-column="adresse" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Limited company')); ?>" class="configuration-global">
- <div class="configuration-icon icon-edit"></div>
+ <div title="<?php p($l->t('This is a first line in the footer of your Quote/Invoice with all legals informations you need')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="legal_one" class="configuration-content editable" data-table="configuration" data-column="legal_one" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Unique identification')); ?>" class="configuration-global">
- <div class="configuration-icon icon-category-enabled"></div>
+ <div title="<?php p($l->t('This is a second line in the footer of your Quote/Invoice with all legals informations you need')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="legal_two" class="configuration-content editable" data-table="configuration" data-column="legal_two" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Phone number')); ?>" class="configuration-global">
- <div class="configuration-icon icon-phone"></div>
+ <div title="<?php p($l->t('Phone number appear in the quote/invoice header')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="telephone" class="configuration-content editable" data-table="configuration" data-column="telephone" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Email')); ?>" class="configuration-global">
- <div class="configuration-icon icon-mail"></div>
+ <div title="<?php p($l->t('Email appear in the quote/invoice header')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="mail" class="configuration-content editable" data-table="configuration" data-column="mail" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Default VAT')); ?>" class="configuration-global">
- <div class="configuration-icon icon-info"></div>
+ <div title="<?php p($l->t('Global Default VAT apply to your Quote/Invoice (globally), to change it, please just insert VAT amount without the percent sign')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="tva_default" class="configuration-content editable" data-table="configuration" data-column="tva_default" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
- <div title="<?php p($l->t('Automatic invoice number')); ?>" class="configuration-global">
- <div class="configuration-icon icon-category-dashboard"></div>
+ <div title="<?php p($l->t('Automatic generated invoice number')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <select style="float:none;" id="auto_invoice_number" class="configuration-content editableSelect" data-table="configuration" data-column="auto_invoice_number" data-id=""></select>
  </div>
- <div title="<?php p($l->t('Default Currency')); ?>" class="configuration-global">
- <div class="configuration-icon icon-rename"></div>
+ <div title="<?php p($l->t('Global default Currency')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <select style="float:none;" id="currency" class="configuration-content editableSelect" data-table="configuration" data-column="devise" data-id=""></select>
  </div>
- <div title="<?php p($l->t('Legal disclaimer/mentions')); ?>" class="configuration-global">
- <div class="configuration-icon icon-comment"></div>
+ <div title="<?php p($l->t('Legal disclaimer/mentions you need in your footer - before company information')); ?>" class="configuration-global">
+ <div class="configuration-icon icon-details"></div>
  <div style="float:none;" id="mentions_default" class="configuration-content editable" data-table="configuration" data-column="mentions_default" data-id=""><?php p($l->t('Loading …')); ?></div>
  </div>
 </div>
diff --git a/templates/content/devisshow.php b/templates/content/devisshow.php
@@ -78,6 +78,6 @@
  </div>
  <hr />
  <div class="col m-0 pb-0 alert alert-info text-center">
- <p><?php p($l->t('Company'));?> <?php echo $res->entreprise; ?><br /><?php echo $res->adresse; ?><br /> <?php p($l->t('Unique identification'));?> : <?php echo $res->legal_two; ?> - <?php p($l->t('Limited company'));?> : <?php echo $res->legal_one; ?></p>
+ <p><?php echo $res->entreprise; ?><br /><?php echo $res->adresse; ?><br /><?php echo $res->legal_one; ?><br/><?php echo $res->legal_two; ?></p>
  </div>
  </div>
diff --git a/templates/content/factureshow.php b/templates/content/factureshow.php
@@ -79,7 +79,7 @@
  </div>
  <hr />
  <div class="col m-0 pb-0 alert alert-info text-center">
- <p><?php p($l->t('Company'));?> <?php echo $res->entreprise; ?><br /><?php echo $res->adresse; ?><br /> <?php p($l->t('Unique identification'));?> : <?php echo $res->legal_two; ?> - <?php p($l->t('Limited company'));?> : <?php echo $res->legal_one; ?></p>
+ <p><?php echo $res->entreprise; ?><br /><?php echo $res->adresse; ?><br /><?php echo $res->legal_one; ?><br/><?php echo $res->legal_two; ?></p>
  </div>
  </div>
 
diff --git a/tests/Unit/Panther/screens/about.png b/tests/Unit/Panther/screens/about.png
diff --git a/tests/Unit/Panther/screens/config.png b/tests/Unit/Panther/screens/config.png
diff --git a/tests/Unit/Panther/screens/devis.png b/tests/Unit/Panther/screens/devis.png
diff --git a/tests/Unit/Panther/screens/facture.png b/tests/Unit/Panther/screens/facture.png
diff --git a/tests/Unit/Panther/screens/index.png b/tests/Unit/Panther/screens/index.png
diff --git a/tests/Unit/Panther/screens/produit.png b/tests/Unit/Panther/screens/produit.png
diff --git a/tests/Unit/Panther/screens/selectFolder.png b/tests/Unit/Panther/screens/selectFolder.png
diff --git a/tests/Unit/Panther/screens/statistique.png b/tests/Unit/Panther/screens/statistique.png
diff --git a/translationfiles/templates/gestion.pot b/translationfiles/templates/gestion.pot
diff --git a/vendor/autoload.php b/vendor/autoload.php
diff --git a/vendor/composer/ClassLoader.php b/vendor/composer/ClassLoader.php
diff --git a/vendor/composer/LICENSE b/vendor/composer/LICENSE
diff --git a/vendor/composer/autoload_classmap.php b/vendor/composer/autoload_classmap.php
diff --git a/vendor/composer/autoload_namespaces.php b/vendor/composer/autoload_namespaces.php
diff --git a/vendor/composer/autoload_psr4.php b/vendor/composer/autoload_psr4.php
diff --git a/vendor/composer/autoload_real.php b/vendor/composer/autoload_real.php
diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php
diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json