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

Integration with Maven Site Plugin: document title is not set #739

Closed
1 of 3 tasks
raoulvdberge opened this issue Jan 11, 2024 · 7 comments
Closed
1 of 3 tasks

Integration with Maven Site Plugin: document title is not set #739

raoulvdberge opened this issue Jan 11, 2024 · 7 comments

Comments

@raoulvdberge
Copy link

raoulvdberge commented Jan 11, 2024

Thank you for taking your time to talk with us!

What is this issue about?

  • Bug report
  • Feature request
  • Question

Description

I have Asciidoc documents that I'm loading into a Maven site.

However, the HTML page title is always empty, in the form of "site name - ". It seems to ignore the document title.

How can I make it use the document title?

This is my maven config:

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-site-plugin</artifactId>
                <version>3.12.1</version>
                <configuration>
                    <generateReports>false</generateReports>
                    <generateSitemap>true</generateSitemap>
                    <relativizeDecorationLinks>false</relativizeDecorationLinks>
                    <locales>en</locales>
                    <inputEncoding>UTF-8</inputEncoding>
                    <outputEncoding>UTF-8</outputEncoding>
                    <asciidoc>
                        <attributes>
                            <source-highlighter>coderay</source-highlighter>
                            <coderay-css>style</coderay-css>
                        </attributes>
                    </asciidoc>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>org.asciidoctor</groupId>
                        <artifactId>asciidoctor-maven-plugin</artifactId>
                        <version>2.2.4</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

Environment information

  • asciidoctor-maven-plugin version: 2.2.4
  • asciidoctorj version: not set, default bundled with 2.2.4
  • Maven, Java and OS version:
Java version: 17.0.9, vendor: Eclipse Adoptium, runtime: .jdks\temurin-17.0.9
Default locale: nl_BE, platform encoding: UTF-8
OS name: "windows 11", version: "10.0", arch: "amd64", family: "windows"
@abelsromero
Copy link
Member

Not sure I understand, each document title should appear on the page as seen in the examples

image

On top of that, there's the site title, which comes from the pom's project name.

@abelsromero
Copy link
Member

abelsromero commented Jan 11, 2024

Btw, I was planning to release v3.0.0 soon-ish ™️ and that provides a new maven-site module that offers a better out of the box experience with fluido, no need to add custom CSS. If that's your goal maybe you want to give it a try? You'll find that several elements are not correctly displayed in the current module because the HTML (elements, clasess, etc.) don't match the default fluido CSS styles.

@raoulvdberge
Copy link
Author

Hi, sorry, typed this issue out when my brain was quite fried 😁

I meant the html page title, between the <title> tags. It doesn't seem to put the asciidoc document title there.

@abelsromero
Copy link
Member

I meant the html page title, between the <title> tags. It doesn't seem to put the asciidoc document title there.

The module embeds the page without headers. The the menu/toc, top section and meta are handled by maven-site, not asciidoctor.
The interface does not provide a way to customize meta, but it's something we could discuss with the maven team.

@abelsromero
Copy link
Member

It seems something similar was discussed some time ago but went stale https://issues.apache.org/jira/browse/DOXIA-471?jql=project%20%3D%20%22Maven%20Doxia%22%20AND%20text%20~%20title. Before re-opening it'd be good to do some extra research, maven-site team is working on a new major, so it's the time to propose breaking changes.

@abelsromero
Copy link
Member

abelsromero commented Nov 2, 2024

I saw this feature was fixed with #763 and release in v3.0.0.
Now the title is set as "${title} - ${project name}", note the project name is appended automatically by Doxia.

image

@abelsromero abelsromero added this to the 3.0.0 milestone Nov 2, 2024
@raoulvdberge
Copy link
Author

Thanks for this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants