From kde-doc-english Mon Aug 15 13:28:53 2005 From: Burkhard =?iso-8859-15?q?L=FCck?= Date: Mon, 15 Aug 2005 13:28:53 +0000 To: kde-doc-english Subject: [kde-doc-english] check of consistency between gui and docbooks Message-Id: <200508151528.54139.lueck () hube-lueck ! de> X-MARC-Message: https://marc.info/?l=kde-doc-english&m=112411261102573 Hi, I wrote some scripts to check the consistency of guiicon, guibutton, guimenu, guimenuitem, guisubmenu and guilabel entries in the docbooks with the strings in the message catalogues. The last nightly walk over l10n/templates/documentation generates 328 logfiles like the following extract from kspread-kde35-templates-docbook.log: Generated by checkdocbook.py for kde35/kspread on Sun Aug 14 19:43:33 2005 UTC in 15 min 54 sec Message Catalogues: kdelibs.pot koffice.pot kofficefilters.pot kspread.pot kspreadcalc_calc.pot kspreadinsertcalendar.pot Docbooks: importexport.docbook commands.docbook basics.docbook config.docbook advanced.docbook faq.docbook index.docbook configdialog.docbook format.docbook Matching rules / Applied filters: guiitems in docbooks: removed one leading/trailing blank removed trailing "..." [snip] catalogue items: removed clashes (&), replaced "&&" with "&" [snip] SUMMARY: 341 guiitems found at 620 locations in 9 docbook(s) guiitems in docbooks found in 6 messages catalogues: 240 of 341 = 70 % guiitems in docbooks NOT found in 6 messages catalogues: 101 of 341 = 30 % BUGREPORT Template importexport.docbook:#88 Other options in this dialog box let you define the Format of the spreadsheet cells, whether text quote characters should be "Format " -> "Format" d=1 (kspread.pot) "Format:" d=1 (kspread.pot) "Format:" d=1 (kofficefilters.pot) [snip] The errors indicate often misspelling, wrong strings, sometimes just wrong markup and sometimes a very outdated documentation. More then half of the errors could be fixed without starting the application to look for the right strings. In addition the scripts generate a summary.log: SUMMARY: playground-utils/kro with 1 docbook(s), 1 errors in 6 guiitems [snip long list of another 326 applications ] kdelibs/kdelibs with 5 docbook(s), 0 errors in 0 guiitems No of documentations = 328 No of documentations with errors 254 of 328 = 77 % No of documentations without errors 74 of 328 = 23 % 14545 guiitems found at 26739 locations in 999 docbook(s) guiitems in docbooks found in 932 catalogues: 8607 of 14545 = 59 % guiitems in docbooks NOT found in 932 catalogues: 5938 of 14545 = 41 % To improve the scripts I need some help regarding the matching rules for the strings (in KDE DocBook Authors guide, chapter 8, there is only a statement for guilabels), automatic detection of message catalogues used by an application and so on. Any interest? Burhard Lück _______________________________________________ kde-doc-english mailing list kde-doc-english@kde.org https://mail.kde.org/mailman/listinfo/kde-doc-english