Certain extension points are not explained anywhere

[raducoravu]

For example all the extension points in the pdf2 plugin:

<extension-point id="org.dita.pdf2.xsl.topicmerge" name="PDF2 topic merge XSLT import"/>
<extension-point id="depend.org.dita.pdf2.format.pre" name="Formatting pre-target"/>
<extension-point id="depend.org.dita.pdf2.format" name="Formatting target"/>
<extension-point id="depend.org.dita.pdf2.format.post" name="Formatting post-target"/>
<extension-point id="org.dita.pdf2.catalog.relative" name="Configuration XML catalog"/>
<extension-point id="dita.conductor.pdf2.param" name="PDF XSLT parameters"/>

I cannot find them anywhere in the docs. Actually I cannot find in the docs a list with all extension points anymore.

[infotexture]

Looks like the old extension-points.dita topic was disabled for v1.5.4 w/ commit dita-ot/dita-ot@7d0f127. The file was later removed along with other unreferenced files for #15.

Most of the information in that topic was included in the new plug-in section of the Developer Reference, in topics like Extending the XML Catalog, which mentions org.dita.pdf2.catalog.relative.

But that can be tough to find, so it would be good to have a complete list of all extension points in one place, and point to additional information on each where available.

We might want to consider generating that list like we do with the messages and Ant parameters.

Any other opinions or suggestions?

[keberlein]

Roger, check out the topics in the attached ZIP. These were reworks of the content that I started a long time back, might be useful ...

[jelovirt]

I think we should generate the list of extension points like we do for messages and will for parameters. Then, use pushconref to add additional descriptions.

[raducoravu]

Maybe each extension point would have some metadata embedded in the plugin.xml explained what it could be used for.

[jelovirt]

Each extension already has a @name attribute, which is basically equivalent to @desc. We're unfortunately stuck with the old name, even though @desc would be more descriptive.

@infotexture the description text for extension-point/@name in should probably say it's a description, not just a "name".

[infotexture]

OK, I'll make that change when I merge in the WIP from @keberlein for #21.

[keberlein]

Just as long as the topics are reviewed for quality/technical accuracy/etc. They'll need some additional work for sure; I had not completed work on them when I last touched them who knows how long ago. (But if they are helpful, great.)

Kris

Sent from my iPad

On Apr 2, 2015, at 6:36 AM, Roger Sheen notifications@github.com wrote:

OK, I'll make that change when I merge in the WIP from @keberlein for #21.

—
Reply to this email directly or view it on GitHub.

[infotexture]

A list of all extension points is now generated automatically, so this issue can be closed when the name attibute description is revised.