Skip to content

Add the shared documentation snippets as XML entities - #10

Draft
lacatoire wants to merge 1 commit into
php:mainfrom
lacatoire:entities-snippets
Draft

Add the shared documentation snippets as XML entities#10
lacatoire wants to merge 1 commit into
php:mainfrom
lacatoire:entities-snippets

Conversation

@lacatoire

Copy link
Copy Markdown
Member

The extension pages migrated out of the main manual reference snippets that are
defined in doc-en/language-snippets.ent, a file this repository does not carry
over. An undefined entity is a fatal XML error, not a warning, so the manual does
not parse without them.

Counting against the seven extensions prepared for migration (#3 to #9), 30 entities
would be undefined: 20 shared ones, added here, and 10 used by a single extension,
added in that extension's own pull request as reference/<extension>/entities.ent,
which text-entities.php collects on its own.

They are declared as XML entities under entities/, not as DTD entities.

Three of them link into the main manual, pecl.info, libxml.required and
pecl.windows.download. Their linkend has no target in this manual, so they now
go through the entities of entities/main-manual.ent added in #2.

The extension pages migrated out of the main manual reference snippets
that live in doc-en/language-snippets.ent, which is not carried over.
Without them the manual does not parse, as an undefined entity is a
fatal XML error rather than a warning.

They are added as XML entities under entities/, per the policy for this
repository, rather than as DTD entities. Three of them link into the
main manual and now go through the entities of entities/main-manual.ent
instead of a linkend that has no target here.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant