louisdevie/mustangproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix documentation

Browse Source 
The typos were found by codespell.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
This commit is contained in:
Stefan Weil
2023-05-16 08:06:15 +02:00
parent 4bde4516ea
commit 5a61779ee4
3 changed files with 36 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
History.md
View File

@@ -59,7 +59,7 @@
=======
2022-09-22
Removed a unneccessary dependency (ph-jaxb).
Removed an unnecessary dependency (ph-jaxb).
Added some javadoc.
2.5.5
@@ -193,7 +193,7 @@ To prevent regressions it is recommended to re-validate your PDF output after up
- allow 1.2 and 2.0 in RDF versions for XRechnung 2.0 Referenzprofil
- also use shortcut "t" for extended in zf1 #230
- falscher Text in Exception #237
- pr 240 ignore input pdf errors when specfied on command line https://github.com/ZUGFeRD/mustangproject/pull/240
- pr 240 ignore input pdf errors when specified on command line https://github.com/ZUGFeRD/mustangproject/pull/240
- pr 241 use sepa transfer instead of bank transfer https://github.com/ZUGFeRD/mustangproject/pull/241
- be able to validate Order-X files
@@ -301,7 +301,7 @@ switch
- new invoicecorrection class
- order-x xml read support
- support included notes on document and item level
- occurence periods setOccurrencePeriod(Date start, Date end)
- occurrence periods setOccurrencePeriod(Date start, Date end)
- automated tests zuv/verapdf validate created library test files
- trans.getTradeSettlementPayment() removed in favor of trans.getTradeSettlement()
- commandline option for no notices
@@ -366,7 +366,7 @@ Mustangproject 1.7.6
2020-02-06
- support different ship to address
- allow for diffent namespace prefixes #140
- allow for different namespace prefixes #140
- include exemption reason if doing intra community supply
- allow different currencies also for ZF2 (#150)
- minor correction VAT exemptions

12
Release_Notes.md
View File

@@ -1,18 +1,18 @@
## Changes
On it's official website you can [download](https://www.mustangproject.org/deploy/Mustang-CLI-2.0.0.jar) Mustang 2.
On its official website you can [download](https://www.mustangproject.org/deploy/Mustang-CLI-2.0.0.jar) Mustang 2.
* Factur-X/ZUGFeRD 2 is now the default. In Mustangproject 1.x one had to select ZUGFeRD version 2 if that was desired, in Mustangproject 2 one now has to select ZUGFeRD version 1 if version 2 is not appropriate.
* Mustang is now available via Maven Central, which makes it even easier to use the Mustang library. Apart from making it easier in Maven because there is no longer the need to mention the custom repository, it also makes it possible to use Mustang in Gradle projects
* ZUGFeRD 2.1.1 is now supported with it's XRechnung "reference profile". The previous stable version, Mustang 1.7.8, only supported ZUGFeRD 2.1.
* ZUGFeRD 2.1.1 is now supported with its XRechnung "reference profile". The previous stable version, Mustang 1.7.8, only supported ZUGFeRD 2.1.
* There is now an experimental visualization feature and an improved experimental upgrade functionality from ZF1 XML to ZF2 XML.
* Mustang now supports percentual and absolute charges and allowances on both item and document level
* Mustang can now embed additional invoice-accompanying files like plans or worklists into the PDFs
* Additionally to the usual interface-based architecture there are now also classes for invoice, tradeparty etc., which makes it easier to develop in the Mustang library. Please feel free to have a look at it's tests on https://github.com/ZUGFeRD/mustangproject/blob/master/library/src/test/java/org/mustangproject/ZUGFeRD/ZF2PushTest.java.
* Additionally to the usual interface-based architecture there are now also classes for invoice, tradeparty etc., which makes it easier to develop in the Mustang library. Please feel free to have a look at its tests on https://github.com/ZUGFeRD/mustangproject/blob/master/library/src/test/java/org/mustangproject/ZUGFeRD/ZF2PushTest.java.
* Mustang now includes a validator, which can check the syntactical correctness of an e-invoice.
The validator component has previously been developed under the name ZUGFeRD and VeraPDF "ZUV".
It is now mature enought to be merged into the Mustang mainstream project.
It is now mature enough to be merged into the Mustang mainstream project.
ZUV already was the validator behind https://www.zugferd-community.net/de/open_community/validation with around 1,000 validations/month alone,
supports ZUGFeRD 1 and ZUGFeRD 2 and can be used via commandline.
Additionally, the Mustang validator now also supports XRechnung 2, can now also be used as library and supports validation of whole directory trees.
@@ -20,7 +20,7 @@ Additionally, the Mustang validator now also supports XRechnung 2, can now also
### Use on command line
`java -jar Mustang-CLI-2.0.0-alpha3.jar --action=combine` embedds a XML into a PDF (A-1) file and exports as PDF/A-3
`java -jar Mustang-CLI-2.0.0-alpha3.jar --action=combine` embeds a XML into a PDF (A-1) file and exports as PDF/A-3
`java -jar mustang-cli.jar --action=extract` extracts XML from a ZUGFeRD file and
@@ -45,7 +45,7 @@ We're now on maven central, please remove the old github repository. Additionall
If you want you can also embed the validator in your software using validator
as artifact ID. "validator" includes the library functionality but is >20 MB
bigger due to it's dependencies.
bigger due to its dependencies.
### Update from Mustang 1.x to 2.0

10
doc/development_documentation.md
View File

@@ -17,11 +17,11 @@ You may already start developing what you wanted. Of course you can use any edit
2. fork
Once you can build, the idea is that you contribute patches via pull requests. For this you need a github account and a personal copy of the repository to store your changes in. Just klick fork on the mustangproject. On your copy you will have git write access. My suggestion as git client is sourcetree (I can send you instructions how to set it up).
Once you can build, the idea is that you contribute patches via pull requests. For this you need a GitHub account and a personal copy of the repository to store your changes in. Just click fork on the mustangproject. On your copy you will have git write access. My suggestion as git client is sourcetree (I can send you instructions how to set it up).
3. branch
If you do a pull request, please do a feature branch, e.g. if you are working on a feature abc you could call your branch feature_abc. Merge requests unfortunately don't work if you don't have a branch you request merge of. Technically we follow the "github flow" strategy (not to be exchanged with the more sophisticated "git flow" strategy)
If you do a pull request, please do a feature branch, e.g. if you are working on a feature abc you could call your branch feature_abc. Merge requests unfortunately don't work if you don't have a branch you request merge of. Technically we follow the "GitHub flow" strategy (not to be exchanged with the more sophisticated "git flow" strategy)
4. test
@@ -38,7 +38,7 @@ library.
![Architecture of mustangproject](Mustang-Architecture.svg "Graph of the architecture of Mustangproject")
The validator component embeds VeraPDF, a open-source
The validator component embeds VeraPDF, an open-source
PDF/A-validator, via maven dependency and uses standard java
checks against schema and ph-schematron for checks against the schematron
to validate the XML part of the invoices.
@@ -151,7 +151,7 @@ The whole settings.xml then looks e.g. like this
</settings>
```
The TOKEN is generated on github.
The TOKEN is generated on GitHub.
Deployment to maven central is described e.g. on [dzone](https://dzone.com/articles/publish-your-artifacts-to-maven-central).
See the following screenshot:
Sign in in GitHub and click on the profile picture -> Settings. Now just generate a new token and set the checkboxes from the screenshot.
@@ -221,7 +221,7 @@ the included file
* Update documentation
* write/translate announcement
* release via/for mvn
* Publish a github release
* Publish a GitHub release
* update mustangproject.org RE
* version number and release date
* sample file?