php / php/doc-base

Manual infra-estructure

Open
#199 0 comments 0 reactions 0 assignees View on GitHub

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-dir on configure.php and sub scripts
Idempotent build
  • Create doc-base/temp and .gitkeep it (#200)
  • Rewrite file-entities.ent.in to use temp/ (#201)
  • Change configure.php to be a little more idempotent (#202)
  • Change manual.xml.in into stable manual.xml (#210)
  • Move PhD files PhD repo (https://github.com/php/phd/pull/261)
  • Move PhD files to doc-base/temp/
  • Move .manual.xml to doc-base/temp/ (coordenate with PhD)
  • Move remaining .gitignore files to temp/
Manual split and DTD entites
  • Move manual.xml from doc-base to doc-en (#324)
  • Move/merge XML files from doc-base to doc-en (https://github.com/php/doc-en/pull/5682)
  • Move/convert entitiy files from doc-base to doc-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.xml from 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 on doc-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.xml and version.xml at the end of configure.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 $mixin from doc-base/scripts/file-entities.php (#207)
  • Remove BACKPORT from doc-base/scripts/file-entities.php (#213)
  • Rewrote $mixin as 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
Failed
  • Native `DOMDocument->xinclude() (?)
  • LIBXML_NOBLANKS (#304)
  • LIBXML_NSCLEAN (#315)
  • GitHub actions/checkout merge stuck in the past (#329)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.