doc-base icon indicating copy to clipboard operation
doc-base copied to clipboard

Manual infra-estructure

Open alfsb opened this issue 2 months ago • 0 comments

Planned changes, big and small, that affect manual infrastructure and languages.

Recheck

  • [x] Single source revcheck (#111 #174 #176 #180)
  • [x] Sequential [skip-revcheck] (#178)
  • [ ] Accidental [skip-revcheck] (#181)

Configure

  • [X] List of active languages on `doc-base (#186)
  • [X] Nested/recursive XIncludes (#194)
  • [x] XInclude failures less fatal on translations (#196)
  • [x] XInclude by xml:id (#198)
  • [ ] XML Entities (#183)
  • [ ] Split language-snippets.ent
  • [ ] Convert all other .ent files to normal XML
  • [ ] Loads and saves an manual.xml with recover = true, if first loading failed
  • [ ] Integrate qaxml.php as XML post validation

Idempotent build

  • [x] Create doc-base/temp and .gitkeep it (#200)
  • [x] Rewrite file-entities.ent.in to use temp/ (#201)
  • [x] Change configure.php to be a little more idempotent (#202)
  • [x] Change manual.xml.in into stable manual.xml (#210)
  • [ ] Workaround cached merge commit target of GitHub CI
  • [ ] Move .manual.xml to temp/ (coordinated)
  • [ ] Move all remaining .gitignore entries to temp/ (coordinated)

Performance/tools

  • [x] Avoid file entities for directories as individuai files (#218)
  • [x] Rewrite sync XML for Attributes (#215)
  • [x] Rewrite sync XML for Entities (#219)
  • [ ] Rewrite sync XML for Processing Instructions
  • [ ] Rewrite sync XML for Tags
  • [ ] Rewrite sync XML for Whitespace
  • [ ] Move generation of sources.xml outside and after validation on configure.php
  • [ ] Move generation of version.xml outside and after validation on configure.php
  • [ ] Move generation any residual of PhD stuff outside and after manual validation
  • [ ] R&D alternative for file entities/inclusions (may affect XInclude)

Clean up / TODOs

  • [x] Trim local repository status on configure.php (#205)
  • [x] Remove $mixin from doc-base/scripts/file-entities.php (#207)
  • [x] Remove BACKPORT from doc-base/scripts/file-entities.php (#213)
  • [x] Rewrote $mixin as an check/error on all OS (#213)

Not discussed, just a list of dreams and/or pet peeves

  • Make <?phpdoc more general
  • Remove all mentions of <xi:fallback>, XML and code
  • Remove all manually edited <!ENTITY> files
  • Mentoring translations about XInclude failures and qaxml alerts

alfsb avatar Dec 04 '24 13:12 alfsb