apache / apache/maven-site-plugin

[MSITE-1000] Allow parametrisation of Doxia parser per file

Open
#1,121 4 comments 0 reactions 1 assignee Claimed by @kwin View on GitHub
enhancement priority:major
Dominant language
Java
Stars
55
Forks
50
Avg merge
2d 7h
Merged PRs (30d)
11

Description

**[Konrad Windszus](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=kwin)** opened **[MSITE-1000](https://issues.apache.org/jira/browse/MSITE-1000?redirect=false)** and commented

Currently only the attributes used for rendering the site can be parameterized in https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#attributes. There is no possibility to configure the parser in https://github.com/apache/maven-doxia-sitetools/blob/dacaa552c1b8e89eed84db0f43b6b0a72be91d0c/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java#L322 per document.

This would be nice in the context of https://issues.apache.org/jira/browse/DOXIA-722 where generation of anchors should be switched on/off for certain documents. Also generation of comments may be desirable for certain documents.

I propose the following additional plugin goal parameter:

```



**/apt/**

false
true

```

where `parserConfigurations` is an array of a complex type with (include) patterns on the source path (String array) and boolean methods for features.

This also required an upgrade to Maven Plugin Tools 3.13.0.

---

**Issue Links:**
- [DOXIASITETOOLS-324](https://issues.apache.org/jira/browse/DOXIASITETOOLS-324) Allow configuration of parser per markup
(_**"is blocked by"**_)
- [DOXIA-722](https://issues.apache.org/jira/browse/DOXIA-722) Optionally create anchors for indexable entries (used in TOC macro)

**Remote Links:**
- [GitHub Pull Request #171
](https://github.com/apache/maven-site-plugin/pull/171)
- [GitHub Pull Request #177
](https://github.com/apache/maven-site-plugin/pull/177)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.