Third-party manual, doc-en side - #5682
Conversation
|
There is an alternative plan. To first move only |
|
Took the path for minimal changes. I planned to merge both sides in about two weeks. Splitted manuals can be fully functional by early August. |
6afad18 to
0086d86
Compare
0086d86 to
b58484f
Compare
|
The force pushes are to re-run Checks against master HEAD instead master past, pure rebases, or for another reason? |
|
The rebase + force push were made to apply the latest docbook-cs configuration that came with a few fixes that affected this PR. One of those was the absence of The violations that remain are actual violations that would be good to address. No code has been changed here during the force push. |
So you are directly observing the GH checks being stuck in the past, and/or ignoring posterior changes on master?
This got me curious. docbookcs loads all DTD and XML .ent files, to merge them and use them in each file validation? Something like this?
Planned after manual split settles down.
I recently came across the |
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.