From de14a5ef5b11d3d9de0899c63980199bce6da1a7 Mon Sep 17 00:00:00 2001 From: jstaerk Date: Mon, 13 Sep 2021 11:50:22 +0200 Subject: [PATCH] updated documentation, little translations, version number --- .gitignore | 1 + README.md | 83 ++++++++++------------------------------- doc/development.md | 65 ++++++++++++++++++++++++++++++++ doc/electron.md | 9 ----- package.json | 2 +- src/translation/de.json | 2 +- 6 files changed, 87 insertions(+), 75 deletions(-) create mode 100644 doc/development.md diff --git a/.gitignore b/.gitignore index c651d05..857355a 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,6 @@ node_modules electron-webpack-quick-start/node_modules out dist +release #Electron-builder output /dist_electron \ No newline at end of file diff --git a/README.md b/README.md index 3350821..533b0a7 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,21 @@ Quba-Viewer Quba-Viewer ([homepage](https://www.quba-viewer.org)) is a cross platform open source application to display structured (i.e., XML) and hybrid (Factur-X/ZUGFeRD PDF) electronic invoices. - +Documentation-wise there is a doc RE [Architecture, Development, Debugging and testing](doc/development.md) in +general and some Electron and E-Invoice peculiarities like [interprocess (IPC) communication, XSLT and codelists](doc/electron.md) in particular. History =============
+1.1 21.09.2021 + - #6 New document shows still old data / invoice + - Switch to vue.js + - i18n: Support for EN and FR +
+1.0 23.08.2021 + - #5 Codelists are now resolved + - Support for first FX Extended Element, i.e., Cash Discount in XML + 0.5 27.07.2021 - Support for PDF - Support for Factur-X/ZUGFeRD @@ -27,73 +37,18 @@ History - release for Windows on 2021-03-31, for Linux on 2101-04-16 and for Mac on 2021-04-27 -Architecture -============= -This viewer is a simple [electron](https://www.electronjs.org/) application (just use `npm start` to run) -which uses [XSLT files](https://github.com/itplr-kosit/xrechnung-visualization) to convert XML to HTML. - - -In the doc folder there is a documentation on [Electron fundamentals and XSLT details](doc/electron.md). - -Development -============= - - -Set up one time with -``` - -npm install --global electron-builder -npm install --global electron-forge -npm update -``` -then - -``` -npm run start -``` - - - -Debugging and testing -============= - -Use CTRL+B to open the developer console. -`npm start` of course starts the application for local testing. - -``` -npm run start -``` -should tell you if the software runs - -``` -npm run build -``` -will build a version, which you can install e.g. with `dist\quba_viewer Setup 0.2.0.exe`. -If you do not run it from the start menu, but in a shell directly from -`\Users\\AppData\Local\Programs\quba_viewer\quba_viewer.exe` -you will also see potential error output on the console. - -Common issues include listing runtime dependencies as devDepencencies -or not listing files to be included in the deployment in the build.files.filter -(both issues can be fixed in the package.json). - - -Deployment -============= +Pedigree +------------- -The final update can then be deployed by Github users who have been granted access -via a powershell using +The FeRD had published visualization XSLTs for ZF1 (~=UN/CEFACT C13B) as open source, unfortunately the ones for the UN/CEFACT C16B-based +version 2 remains proprietary. The Kosit released XSLT for both CII and UBL of the XRechnung (XR) which has been used for various online viewers +but also for offline viewers like Ultramarinviewer and Open XRechnung Toolbox. Quba uses this work added translations and +at least experimental support for Factur-X/ZUGFeRD profiles higher than EN16931. -``` -$env:GH_TOKEN = '' -npm run publish -``` +![History of Quba](doc/History_of_Quba-02.svg "Pedigree of Quba") -To access the console (not only of the browser windows but also of main.js) -start Quba in a shell, e.g. -`%AppData%\Local\Programs\quba_viewer\quba_viewer.exe` Known issues ============= - * the invoice output is german \ No newline at end of file + * While XRechnung, EN16931 and below should work, not all FX attributes/elements of the Extended Profile have yet been mapped, feel free to [report missing ones](https://github.com/ZUGFeRD/quba-viewer/issues) \ No newline at end of file diff --git a/doc/development.md b/doc/development.md new file mode 100644 index 0000000..6137474 --- /dev/null +++ b/doc/development.md @@ -0,0 +1,65 @@ +Architecture +============= +This viewer is a simple [electron](https://www.electronjs.org/) application (just use `npm start` to run) +which uses [XSLT files](https://github.com/itplr-kosit/xrechnung-visualization) to convert XML to HTML. + + +In the doc folder there is a documentation on [Electron fundamentals and XSLT details](doc/electron.md). + +Development +============= + + +Set up one time with +``` +npm install --global @vue/cli-service +npm install --global electron-builder +npm install --global electron-forge +npm update +``` +then + +``` +npm run start +``` + + +Debugging and testing +============= + +Use CTRL+B to open the developer console. +`npm start` of course starts the application for local testing. + +``` +npm run start +``` +should tell you if the software runs + +``` +npm run pack +``` +will build a executable installer in releases. + +If you do not run it from the start menu, but in a shell directly from +`\Users\\AppData\Local\Programs\quba_viewer\quba_viewer.exe` +you will also see potential error output on the console. + +Common issues include listing runtime dependencies as devDepencencies +or not listing files to be included in the deployment in the build.files.filter +(both issues can be fixed in the package.json). + + +Deployment +============= +The final update can then be deployed by Github users who have been granted access +via a powershell using + +``` +$env:GH_TOKEN = '' +npm run publish +``` + +To access the console (not only of the browser windows but also of main.js) +start Quba in a shell, e.g. +`%AppData%\Local\Programs\quba_viewer\quba_viewer.exe` + diff --git a/doc/electron.md b/doc/electron.md index 6005498..be68444 100644 --- a/doc/electron.md +++ b/doc/electron.md @@ -95,15 +95,6 @@ e.g. sixpack, hours, kilogram, metres, square metres, litres or cubic foot. -Influence -------------- - -The FeRD had published visualization XSLTs for ZF1 (~=UN/CEFACT C13B) as open source, unfortunately the ones for the UN/CEFACT C16B-based -version 2 remains proprietary. The Kosit released XSLT for both CII and UBL of the XRechnung (XR) which has been used for various online viewers -but also for offline viewers like Ultramarinviewer and Open XRechnung Toolbox. As mentioned, Quba uses this work and will add translation and -at least experimental support for Factur-X/ZUGFeRD profiles higher than EN16931. - -![History of Quba](History_of_Quba-02.svg "Logo Title Text 1") Vue ------------- diff --git a/package.json b/package.json index 6a068d8..ef5172f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "Quba", - "version": "1.0.1", + "version": "1.1.0", "description": "Viewer", "author": "Quba", "scripts": { diff --git a/src/translation/de.json b/src/translation/de.json index b258bb3..afba912 100644 --- a/src/translation/de.json +++ b/src/translation/de.json @@ -2,5 +2,5 @@ "showXML": "Eingebettetes XML anzeigen", "welcomeNote1": "Derzeit werden nur .xml-Dateien unterstützt.", "welcomeNote2": "Öffnen Sie sie über das Menü oder durch Drücken von Strg + O.", - "appName":"E-Rechnungsanzeige" + "appName":"E-Rechnungsviewer" } \ No newline at end of file