Running xmlformat of all docs #318

CWehli · 2023-05-01T15:43:04Z

Adaptation of the xml-formatting example to the changed doc structure.
xmlformat of all xml-docs, both guide and manual and all languages

fellen

[Edit]The first 2 commits are very good, but…[/Edit]
After looking over a few files, I think we need to improve the config file

exactly 1 linefeed between elements of <figure>
1 space before <menuchoice>
1 space after </footnote>, </menuchoice> … if the next character is no sentence sign. This issue is probably easier solved by find&replace than in the config.

C/guide/appendixd.xml

C/guide/ch_accts.xml

CWehli · 2023-07-13T21:05:09Z

@fellen: I have adopted the improvements from PR #312 and #241 respectively and think that the formatting looks better now.
Unfortunately, I don't have a solution for all the improvements you suggested.

@jralls: if @fellen agrees with these changes, #312 can be closed.

fellen

Hi, just to get some progress: I just saw, we have revision twice defined. Please remove it from the inline section. It should be the cause of some strange formating.

C/guide/appendixd.xml

C/guide/ch_accts.xml

fellen

Lesbarkeit erhöht, danke!
Aber siehe Kommentar in util/xmlformat/README

Ein Konflikt ist übrigens vorprogrammiert: https://github.com/Gnucash/gnucash-docs/pull/323/commits
Mal sehen, ob ich die PR vorher reinnehmen kann…

C/guide/ch_accts.xml

fellen · 2023-07-17T20:27:15Z

C/guide/ch_accts.xml

-        Hierarchy (<menuchoice>
+        Hierarchy (
+        <menuchoice>
          <guimenu>Actions</guimenu><guimenuitem>New Account Hierarchy...</guimenuitem>
-        </menuchoice>).
+        </menuchoice>
+        ).


Das dürfte unerwünschte Leerzeichen in der Klammer ergeben, aber macht die Klammer überhaupt Sinn? Gab es da keinen Dokbook-terminus für?.

Wenn im Guide für die Menüeinträge auch die neuen Entities eingearbeitet sind, dann erledigt sich dieses Problem von selber.

fellen · 2023-07-17T20:40:33Z

util/xmlformat/README

-for i in guide/C/*.xml; do util/xmlformat/xmlformat.pl -f util/xmlformat/xmlformat.conf -i $i ; done
+for i in C/guide/*.xml; do util/xmlformat/xmlformat.pl -f util/xmlformat/xmlformat.conf -i $i ; done


Da das Hauptdokument in index.dokbook umbenannt wurde, wird es nicht mehr erfaßt. M.E. die einfachste und sauberste Lösung: Umbennennung der restlichen .xml nach .dokbook (oder aller nach .dbk, was auch eine offizielle Endung sein soll —erfordert Test.)

Das Hauptdokument ist doch recht statisch, das könnten wir doch auch händisch formatieren. Ich würde die einzelnen XML-Dateien am liebsten so lassen.
[edit] ... und 'it' ist ja nicht mehr wirklich aktuell [/edit]

There was @gjanssens not very consequent. ;-)

Wenn du meinst, dann lass es drüber laufen. <revision> wurde von uns geändert [Edit]und [/Edit]wird darin verwendet.

Das Hauptdokument ist doch recht statisch

@jralls adds on each release a section to <revhistory> and is not happy with the current line breaks.

CWehli · 2023-07-18T15:32:20Z

Lesbarkeit erhöht, danke!
Aber siehe Kommentar in util/xmlformat/README

Welchen Kommentar meinst du?

fellen · 2023-07-18T15:47:28Z

Lesbarkeit erhöht, danke!
Aber siehe Kommentar in util/xmlformat/README

Welchen Kommentar meinst du?

https://github.com/Gnucash/gnucash-docs/pull/318/files#r1265881425

fellen · 2023-07-18T16:39:58Z

util/xmlformat/xmlformat.conf

  element-break = 0

+# each sub-element begin a new line:
+figure mediaobject


[Edit]Schön, aber [/Edit]
mediaobject in Zeile 40 dann löschen.

Leider funktioniert die Lösung doch nicht. Bei einem wiederholten Formatierungslauf wird die Leerzeile wieder eingefügt.

Diese Konfigurationsdatei wird sequenziell abgearbeitet kommt. Die Formatierungs-Einträge für ein Element kann weiter hinten in der Datei gezielt überschrieben werden.
So kann anfänglich eine pauschale Formatierung vorgenommen werden, die dann im Nachgang 'feinjustiert' wird.
Mit Zeile 40 wird das mediaobjekt als Block formatiert und hier in Zeile 53 dann mit einer neuen Anweisung ergänzt.

Dann sollten wir unser Layout für die Datei —vielleicht zunächst im Wiki— dokumentieren.

M.E. sollte jedes benutzte Element genau einmal definiert werden, sonst passieren so unschöne Dinge wie mit <revision>.
Mein Ansatz war, Elemente mit gleichen Eigenschaften in Definitionsblöcken zusammenzufassen, also bei Änderungen Elemente zwischen Blöcken zu verschieben.

fellen · 2023-07-18T21:32:45Z

Ein aktualisierter Durchlauf nach rebase wäre schön wegen commit 24a91f0.

fellen · 2023-07-19T17:07:04Z

Die ganzen index.dokbook fehlen immer noch. Dan muß man sie wohl auch im README erwähnen. ;-)

and insert the processing of *.docbook- files to the for-loop.

- set 'element-break' active for 'para', 'figure' and 'mediaobject' - insert 'titleabbrev'

CWehli · 2023-07-19T19:47:36Z

Die ganzen index.docbook fehlen immer noch.

Für die index.docbook habe ich die Formatierung für <revnumber> in Zeile 49 zusätzlich modifiziert und dann am Ende aus dem 'Inline-Format' entfernt.
Und die Readme-Datei habe ich entsprechend ergänzt.

fellen · 2023-07-20T03:45:11Z

OK, despite the result is not perfect we got much progress.
Thanks!

CWehli mentioned this pull request May 1, 2023

Proceeding with the documentation of price quote and gnucash-cli #316

Merged

fellen requested changes Jun 23, 2023

View reviewed changes

C/guide/appendixd.xml Outdated Show resolved Hide resolved

C/guide/ch_accts.xml Outdated Show resolved Hide resolved

C/guide/ch_accts.xml Show resolved Hide resolved

C/guide/ch_accts.xml Outdated Show resolved Hide resolved

C/guide/ch_accts.xml Outdated Show resolved Hide resolved

CWehli force-pushed the xmlformat_all_docs branch from b807ca4 to 97244f8 Compare July 13, 2023 20:56

CWehli requested a review from fellen July 13, 2023 21:05

fellen requested changes Jul 16, 2023

View reviewed changes

C/guide/appendixd.xml Outdated Show resolved Hide resolved

C/guide/ch_accts.xml Outdated Show resolved Hide resolved

CWehli force-pushed the xmlformat_all_docs branch from 97244f8 to 759a7ba Compare July 17, 2023 17:23

fellen requested changes Jul 17, 2023

View reviewed changes

CWehli force-pushed the xmlformat_all_docs branch from 759a7ba to c8562c0 Compare July 18, 2023 15:47

fellen reviewed Jul 18, 2023

View reviewed changes

CWehli force-pushed the xmlformat_all_docs branch from c8562c0 to d4a794b Compare July 18, 2023 19:43

CWehli force-pushed the xmlformat_all_docs branch from d4a794b to 20cd518 Compare July 19, 2023 16:34

CWehli added 4 commits July 19, 2023 21:46

Adaptation of the xml-formatting example to the changed doc structure

57207af

and insert the processing of *.docbook- files to the for-loop.

fix malformed xml

491a29a

xmlformat.conf: further improvements

15d5db1

- set 'element-break' active for 'para', 'figure' and 'mediaobject' - insert 'titleabbrev'

xmlformat of all xml-docs, both guide and manual and all languages

cf5c288

CWehli force-pushed the xmlformat_all_docs branch from 20cd518 to cf5c288 Compare July 19, 2023 19:46

code-gnucash-org merged commit cf5c288 into Gnucash:stable Jul 20, 2023
3 checks passed

CWehli mentioned this pull request Jul 20, 2023

Further improvement in xmlformat #312

Closed

CWehli deleted the xmlformat_all_docs branch May 1, 2024 12:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Running xmlformat of all docs #318

Running xmlformat of all docs #318

CWehli commented May 1, 2023

fellen left a comment •

edited

Loading

CWehli commented Jul 13, 2023

fellen left a comment •

edited

Loading

fellen left a comment •

edited

Loading

fellen Jul 17, 2023

CWehli Jul 18, 2023

fellen Jul 17, 2023

CWehli Jul 18, 2023 •

edited

Loading

fellen Jul 18, 2023 •

edited

Loading

fellen Jul 18, 2023 •

edited

Loading

CWehli commented Jul 18, 2023

fellen commented Jul 18, 2023

fellen Jul 18, 2023 •

edited

Loading

CWehli Jul 18, 2023

fellen Jul 18, 2023

fellen commented Jul 18, 2023

fellen commented Jul 19, 2023

CWehli commented Jul 19, 2023

fellen commented Jul 20, 2023

		for i in guide/C/*.xml; do util/xmlformat/xmlformat.pl -f util/xmlformat/xmlformat.conf -i $i ; done
		for i in C/guide/*.xml; do util/xmlformat/xmlformat.pl -f util/xmlformat/xmlformat.conf -i $i ; done

Running xmlformat of all docs #318

Running xmlformat of all docs #318

Conversation

CWehli commented May 1, 2023

fellen left a comment • edited Loading

Choose a reason for hiding this comment

CWehli commented Jul 13, 2023

fellen left a comment • edited Loading

Choose a reason for hiding this comment

fellen left a comment • edited Loading

Choose a reason for hiding this comment

fellen Jul 17, 2023

Choose a reason for hiding this comment

CWehli Jul 18, 2023

Choose a reason for hiding this comment

fellen Jul 17, 2023

Choose a reason for hiding this comment

CWehli Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

fellen Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

fellen Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

CWehli commented Jul 18, 2023

fellen commented Jul 18, 2023

fellen Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

CWehli Jul 18, 2023

Choose a reason for hiding this comment

fellen Jul 18, 2023

Choose a reason for hiding this comment

fellen commented Jul 18, 2023

fellen commented Jul 19, 2023

CWehli commented Jul 19, 2023

fellen commented Jul 20, 2023

fellen left a comment •

edited

Loading

fellen left a comment •

edited

Loading

fellen left a comment •

edited

Loading

CWehli Jul 18, 2023 •

edited

Loading

fellen Jul 18, 2023 •

edited

Loading

fellen Jul 18, 2023 •

edited

Loading

fellen Jul 18, 2023 •

edited

Loading