Manual infra-estructure
Open
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 371
- Forks
- 131
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 6
Description
Planned changes, big and small, that affect manual infrastructure and languages.
Configure
- List of active languages on `doc-base (#186)
- Nested/recursive XIncludes (#194)
- XInclude failures less fatal on translations (#196)
- XInclude by
xml:id(#198) - Include post validation tools on
configure.php(broken, revtag, entities). (#241) - XML Entities (#183) (#301)
- Smaller XML output (comments, DTD, namespaces, docbook wsi) (#321)
- Recreate
--langs-dironconfigure.phpand sub scripts
Idempotent build
- Create
doc-base/tempand.gitkeepit (#200) - Rewrite
file-entities.ent.into usetemp/(#201) - Change
configure.phpto be a little more idempotent (#202) - Change
manual.xml.ininto stablemanual.xml(#210) - Move PhD files PhD repo (https://github.com/php/phd/pull/261)
- Move PhD files to
doc-base/temp/ - Move
.manual.xmltodoc-base/temp/(coordenate with PhD) - Move remaining
.gitignorefiles totemp/
Manual split and DTD entites
- Move
manual.xmlfrom doc-base to doc-en (#324) - Move/merge XML files from
doc-basetodoc-en(https://github.com/php/doc-en/pull/5682) - Move/convert entitiy files from
doc-basetodoc-en(https://github.com/php/doc-en/pull/5742) - Minimize DTD inclusion on
doc-base/manual.xml(#336) - Erase manual.xml, funcindex.xml and global.ent from
doc-base(#338) - Remove all mentions of
funcindex.xmlfrom code (#338) - Split, convert and delete
language-snippets.ent
Recheck
- Single source revcheck (#111 #174 #176 #180)
- Sequential
[skip-revcheck](#178) - Accidental
[skip-revcheck](#181) -
<?do-not-translate?>mark support ondoc-base(#311) - Annotate files on
doc-en - Remove file exclusions by name convention from revcheck lib (#319)
- "Do not translate" and "XML Broken" sections in revcheck (#334)
Performance/tools
- Avoid file entities for directories as individuai files (#218)
- Rewrite sync XML for Attributes (#215)
- Rewrite sync XML for Entities (#219)
- Rewrite sync XML for Processing Instructions (#222)
- Rewrite sync XML for Tags (#222)
- Rewrite sync XML for Whitespace (#222)
- Move generation of
sources.xmlandversion.xmlat the end ofconfigure.php(#239) - Sync XML tools to accept language parameter and simple file listing (#275)
- Do-not-translate mark, broken test and revtag parse in one file load (#339)
Clean up / TODOs
- Trim local repository status on
configure.php(#205) - Remove
$mixinfromdoc-base/scripts/file-entities.php(#207) - Remove
BACKPORTfromdoc-base/scripts/file-entities.php(#213) - Rewrote
$mixinas an check/error on all OS (#213) - Remove all mentions of
<xi:fallback>in doc-en (https://github.com/php/doc-en/pull/5699) - Block
<xi:fallback>on doc-en (#332)
Future / R&D
- Make
<?phpdocmore general - Userland "XML assembler", that uses only XML Entities
- Recode CHM scripts (https://github.com/php/phd/issues/203)
Failed
- Native `DOMDocument->xinclude() (?)
- LIBXML_NOBLANKS (#304)
- LIBXML_NSCLEAN (#315)
- GitHub actions/checkout merge stuck in the past (#329)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
This is a broad tracking checklist rather than a single change. Start by confirming which unchecked item is in scope, such as recreating --langs-dir in configure.php and its sub-scripts or moving generated files into doc-base/temp/. Done means completing the selected checklist item and updating the issue with its result.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php, xml
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100