Skip to content

Imagick manual parts missing on all languages #5691

Description

@alfsb

There are exactly 1000 <xi:fallback> on doc-en manual. They exist primarily to keep translations building most of the time, but are in fact a blanket authorization to omit XInclude failures in all languages, doc-en inclusive. There is code on configure.php that warns and patch failing XInclude on translations, so <xi:fallback> on XML sources are not necessary anymore. But removing all xi:include on doc-en surfaces 10 failures. That is, doc-en itself is not self consistent, nor are the translations: all languages have missing pages.

So I plan to write a small script that aesthetically removes xi:fallback from XML sources, publish it, and apply it on doc-en, skip-revchek'ed. And later, revamp Xinclude code on configure.php to reject (on doc-en) and warn (on translations) against the presence of xi:fallback. But this will obviously cause doc-en to start failing. So I'm asking for help, into fixing doc-en before I do all of this.

The failing targets that are failing are, as for now:

- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickDrawException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickKernelException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickPixelException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickPixelIteratorException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.imagickdrawexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickDrawException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.imagickexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.imagickkernelexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickKernelException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.imagickpixelexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickPixelException'])
- xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.imagickpixeliteratorexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ImagickPixelIteratorException'])

This would be a hard error even if Imagick docs are moved into extensions manual, as both doc-en and doc-ext will use the same rules of validation and build failures.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions