Move files specific to main manual into doc-en#5682
Open
alfsb wants to merge 1 commit into
Open
Conversation
alfsb
requested review from
Girgias,
derickr,
jordikroon,
kamil-tekiela and
ndossche
July 15, 2026 00:53
ndossche
removed their request for review
July 15, 2026 07:59
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is the first step in preparation for https://wiki.php.net/rfc/third_party_ext_documentation . The main objective is to "move" files that are specific to the main manual into
doc-en, sodoc-basecan build each manual with the minimum of conventions.Also, it intends to stop cross-repositories PRs between manuals and
doc-base, even more so in the many piecewise changes that the splitting of manuals may cause.Many changes in manual.xml already included here:
<set>is reorganized;&global.function-index;is not necessary anymore;global.ent is moved as is, to be manually converted into XML entities later.
If everything goes well, the preamble of manual.xml eventually will contain only two parameter entities, one for text-entities, other for file-entities.
Questions:
This is ok?
There are many changes to be made in doc-base/configure.php (and probably in PhD) to start building the new external extensions/projects manual. Moving these files here, in particular manual.xml, has the potential of making many of these changes unnecessary.
The root
<set>is not missing a xmlns for XInclude?Even if the final XML should not include any XInclude in the end, there many intermediary steps there xi:include tags are valid and expected content of manual building.
Is the version="5.2" in root
<set>necessary?funcindex.xml not moved
This file is small, has no translatable text, so I decided to merge it in manual.xml. But it is referred to by name in PhD and
file-entities.php, so it's necessary to open an issue on PhD, noting its future remotion, I presume. This file used/mentioned elsewhere?acronyms.xml, idem
I do not plan to move this file, as it appears not to be used directly anywhere. I presume it is used in PhD, to patch all acronym elements. I would like to hear some PhD maintainers or translations, in about "converting" this file into translatable XML entities, keyed by acronym.lower. That will need changes on PhD, of course, but will make acronyms translable. The very first acronym, AKA, "Also Known As", is a good example of the necessity of this part of the manual to be translatable.
As third-party efforts already started, I would like to merge this as soon as possible, but I know this a big change, and a controversial one to boot, so I plan to leave this open at least two weeks. Comments and reviews are very welcome.