Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extension points to preprocess2 #4395

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

jelovirt
Copy link
Member

Description

Add extension points to preprocess2 to allow running targets between map and topic processing.

Motivation and Context

Fixes #4394

Type of Changes

  • New feature (non-breaking change which adds functionality)

Documentation and Compatibility

To be listed in extension point list for preprocess2.

Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
@jelovirt jelovirt added feature New feature or request preprocess2 labels Feb 11, 2024
@jelovirt jelovirt linked an issue Feb 11, 2024 that may be closed by this pull request
@@ -51,6 +51,10 @@ See the accompanying LICENSE file for applicable license.
<!-- Deprecated since 2.1 -->
<extension-point id="depend.preprocess.copy-subsidiary.pre" name="Copy subsidiary pre-target"/>
<extension-point id="depend.preprocess.post" name="Preprocessing post-target"/>
<extension-point id="depend.preprocess2.maps.pre" name="Map-first pre-processing maps pre-target"/>
Copy link
Member Author

@jelovirt jelovirt Feb 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@infotexture The copy needs to be better 😄 I'm not sure if we actually use these anywhere, but might as well come up with a good copy for the description.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's follow the pattern we use in the docs for the other Pre-processing extension points:

Suggested change
<extension-point id="depend.preprocess2.maps.pre" name="Map-first pre-processing maps pre-target"/>
<extension-point id="depend.preprocess2.maps.pre" name="Runs an Ant target before pre-processing maps"/>

@@ -51,6 +51,10 @@ See the accompanying LICENSE file for applicable license.
<!-- Deprecated since 2.1 -->
<extension-point id="depend.preprocess.copy-subsidiary.pre" name="Copy subsidiary pre-target"/>
<extension-point id="depend.preprocess.post" name="Preprocessing post-target"/>
<extension-point id="depend.preprocess2.maps.pre" name="Map-first pre-processing maps pre-target"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's follow the pattern we use in the docs for the other Pre-processing extension points:

Suggested change
<extension-point id="depend.preprocess2.maps.pre" name="Map-first pre-processing maps pre-target"/>
<extension-point id="depend.preprocess2.maps.pre" name="Runs an Ant target before pre-processing maps"/>

@@ -51,6 +51,10 @@ See the accompanying LICENSE file for applicable license.
<!-- Deprecated since 2.1 -->
<extension-point id="depend.preprocess.copy-subsidiary.pre" name="Copy subsidiary pre-target"/>
<extension-point id="depend.preprocess.post" name="Preprocessing post-target"/>
<extension-point id="depend.preprocess2.maps.pre" name="Map-first pre-processing maps pre-target"/>
<extension-point id="depend.preprocess2.maps.post" name="Map-first pre-processing maps post-target"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<extension-point id="depend.preprocess2.maps.post" name="Map-first pre-processing maps post-target"/>
<extension-point id="depend.preprocess2.maps.post" name="Runs an Ant target after pre-processing maps"/>

@@ -51,6 +51,10 @@ See the accompanying LICENSE file for applicable license.
<!-- Deprecated since 2.1 -->
<extension-point id="depend.preprocess.copy-subsidiary.pre" name="Copy subsidiary pre-target"/>
<extension-point id="depend.preprocess.post" name="Preprocessing post-target"/>
<extension-point id="depend.preprocess2.maps.pre" name="Map-first pre-processing maps pre-target"/>
<extension-point id="depend.preprocess2.maps.post" name="Map-first pre-processing maps post-target"/>
<extension-point id="depend.preprocess2.topics.pre" name="Map-first pre-processing topics pre-target"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<extension-point id="depend.preprocess2.topics.pre" name="Map-first pre-processing topics pre-target"/>
<extension-point id="depend.preprocess2.topics.pre" name="Runs an Ant target before pre-processing topics"/>

<extension-point id="depend.preprocess2.maps.pre" name="Map-first pre-processing maps pre-target"/>
<extension-point id="depend.preprocess2.maps.post" name="Map-first pre-processing maps post-target"/>
<extension-point id="depend.preprocess2.topics.pre" name="Map-first pre-processing topics pre-target"/>
<extension-point id="depend.preprocess2.topics.post" name="Map-first pre-processing topics post-target"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<extension-point id="depend.preprocess2.topics.post" name="Map-first pre-processing topics post-target"/>
<extension-point id="depend.preprocess2.topics.post" name="Runs an Ant target after pre-processing topics"/>

@infotexture
Copy link
Member

@jelovirt We should probably take this as an opportunity to review the extension point descriptions that we pushreplace from the docs repo and move them to the core repo (but we can treat that as a separate issue):

https://github.com/dita-ot/docs/blob/develop/extension-points/plugin-extension-points-pre-processing.dita#L12-L29

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request preprocess2
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Add extension points to preprocess2
3 participants