Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
I forgot to mention, that it would also be nice to get rid of this content: -- Alexander Kriegisch https://scrum-master.de Alexander Kriegisch schrieb am 22.02.2024 13:59 (GMT +07:00): > Hello Maven community. > > When generating Maven sites, I like to keep the diffs to previous > version to the absolute minimum before committing changes to a > published site. My commits should only contain content changes. > Therefore, I already use this in my site.xml: > > > > true > > > > Unfortunately, I found no way to suppress these generated tags on each > single page: > > > > > They constitute about 90% of my commit diffs, making it look like all > pages have changed in the commit log, even though maybe I just fixed a > typo on a single page. How can I customise that behaviour? - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
I would also like a solution to this, but am no closer to solving it. The noise from these date and version comments in the diffs make finding real changes too difficult.
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
Greg, I am currently using an Antrun regex replace job to remove the version number from "Generated by javadoc ([docletVersion])" comments in javadocs, see the JDK issue I raised: https://bugs.openjdk.org/browse/JDK-8326483 org.apache.maven.plugins maven-antrun-plugin 3.1.0 filter-javadocs package run I could do something similar for this issue, but it is super ugly already and I would like to avoid using more of that stuff. -- Alexander Kriegisch https://scrum-master.de Greg Chabala schrieb am 26.02.2024 00:16 (GMT +07:00): > I would also like a solution to this, but am no closer to solving it. > > The noise from these date and version comments in the diffs make finding > real changes too difficult. - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
On 2024/02/22 06:59:01 Alexander Kriegisch wrote: > Hello Maven community. > > When generating Maven sites, I like to keep the diffs to previous > version to the absolute minimum before committing changes to a published > site. My commits should only contain content changes. Therefore, I > already use this in my site.xml: > > > > true > > > > Unfortunately, I found no way to suppress these generated tags on each > single page: > > > > > They constitute about 90% of my commit diffs, making it look like all > pages have changed in the commit log, even though maybe I just fixed a > typo on a single page. How can I customise that behaviour? I do not fully understand which problem you have. As long as you stay on the same version of all affected components there should be no diff, but only your content change. Can you elaborate? What do you exactly change? The source of that metadata is stable from: * https://github.com/apache/maven-fluido-skin/blob/7cb683f5505badcb7ecac9569c8445ae435377d8/src/main/resources/META-INF/maven/site.vm#L20-L43 * https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/index.html M - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
On Wed, 28 Feb 2024 at 13:40, Michael Osipov wrote: > > On 2024/02/22 06:59:01 Alexander Kriegisch wrote: > > Hello Maven community. > > > > When generating Maven sites, I like to keep the diffs to previous > > version to the absolute minimum before committing changes to a published > > site. My commits should only contain content changes. Therefore, I > > already use this in my site.xml: > > > > > > > > true > > > > > > > > Unfortunately, I found no way to suppress these generated tags on each > > single page: > > > >> /> > > > > > > They constitute about 90% of my commit diffs, making it look like all > > pages have changed in the commit log, even though maybe I just fixed a > > typo on a single page. How can I customise that behaviour? > > I do not fully understand which problem you have. As long as you stay on the > same version of all affected components there should be no diff, but only > your content change. Can you elaborate? What do you exactly change? Suppose you release version 1.2.2 of a project using Doxia 1.11.0 Later you would like to release version 1.2.3, by then Doxia 1.11.1 is out. As part of checking the release, you would like to check that the Javadoc changes properly reflect the code changes. However the Doxia version change generates tons of spurious output. > The source of that metadata is stable from: > * > https://github.com/apache/maven-fluido-skin/blob/7cb683f5505badcb7ecac9569c8445ae435377d8/src/main/resources/META-INF/maven/site.vm#L20-L43 > * > https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/index.html > > M > > - > To unsubscribe, e-mail: users-unsubscr...@maven.apache.org > For additional commands, e-mail: users-h...@maven.apache.org > - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
Sorry for replying slowly due to intercontinental travel. What sebb said is just one issue. The other, even more obviuous one is that a timestamp is a tinmestamp is a timestamp and hence therefore changes each time I generate the site. -- Alexander Kriegisch https://scrum-master.de sebb schrieb am 28.02.2024 15:01 (GMT +01:00): > On Wed, 28 Feb 2024 at 13:40, Michael Osipov wrote: >> >> On 2024/02/22 06:59:01 Alexander Kriegisch wrote: >> > Hello Maven community. >> > >> > When generating Maven sites, I like to keep the diffs to previous >> > version to the absolute minimum before committing changes to a published >> > site. My commits should only contain content changes. Therefore, I >> > already use this in my site.xml: >> > >> > >> > >> > true >> > >> > >> > >> > Unfortunately, I found no way to suppress these generated tags on each >> > single page: >> > >> > > /> >> > >> > >> > They constitute about 90% of my commit diffs, making it look like all >> > pages have changed in the commit log, even though maybe I just fixed a >> > typo on a single page. How can I customise that behaviour? >> >> I do not fully understand which problem you have. As long as you stay on the >> same version of all affected components there should be no diff, but only >> your >> content change. Can you elaborate? What do you exactly change? > > Suppose you release version 1.2.2 of a project using Doxia 1.11.0 > Later you would like to release version 1.2.3, by then Doxia 1.11.1 is out. > > As part of checking the release, you would like to check that the > Javadoc changes properly reflect the code changes. > However the Doxia version change generates tons of spurious output. > >> The source of that metadata is stable from: >> * >> https://github.com/apache/maven-fluido-skin/blob/7cb683f5505badcb7ecac9569c8445ae435377d8/src/main/resources/META-INF/maven/site.vm#L20-L43 >> * >> https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/index.html >> >> M >> >> - >> To unsubscribe, e-mail: users-unsubscr...@maven.apache.org >> For additional commands, e-mail: users-h...@maven.apache.org >> > > - > To unsubscribe, e-mail: users-unsubscr...@maven.apache.org > For additional commands, e-mail: users-h...@maven.apache.org > > - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
On 2024/02/28 14:01:42 sebb wrote: > On Wed, 28 Feb 2024 at 13:40, Michael Osipov wrote: > > > > On 2024/02/22 06:59:01 Alexander Kriegisch wrote: > > > Hello Maven community. > > > > > > When generating Maven sites, I like to keep the diffs to previous > > > version to the absolute minimum before committing changes to a published > > > site. My commits should only contain content changes. Therefore, I > > > already use this in my site.xml: > > > > > > > > > > > > true > > > > > > > > > > > > Unfortunately, I found no way to suppress these generated tags on each > > > single page: > > > > > > > > > > > > > > > They constitute about 90% of my commit diffs, making it look like all > > > pages have changed in the commit log, even though maybe I just fixed a > > > typo on a single page. How can I customise that behaviour? > > > > I do not fully understand which problem you have. As long as you stay on > > the same version of all affected components there should be no diff, but > > only your content change. Can you elaborate? What do you exactly change? > > Suppose you release version 1.2.2 of a project using Doxia 1.11.0 > Later you would like to release version 1.2.3, by then Doxia 1.11.1 is out. > > As part of checking the release, you would like to check that the > Javadoc changes properly reflect the code changes. > However the Doxia version change generates tons of spurious output. True, that is what I wanted to hear. I have/had the same problem during dev/testing. Raise an issue with the skin, please. - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
On 2024/03/01 15:34:42 Alexander Kriegisch wrote: > Sorry for replying slowly due to intercontinental travel. > > What sebb said is just one issue. The other, even more obviuous one is > that a timestamp is a tinmestamp is a timestamp and hence therefore > changes each time I generate the site. Which exact? The generation date can be skipped, there are no other skin-supplied dates or timestamps embedded. M - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
Michael, did you read my original message? Everything is described quite precisely and concisely there. > I already use this in my site.xml: > > > > true > > > > Unfortunately, I found no way to suppress these generated tags on each > single page: > > > I.e., that setting does *not* stop timestamp meta tags from being generated, only timestamps visible on generated pages. This is why the subject of this thread is: "How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?" I was asking, because I was hoping that somebody could tell me if there were any existing options to suppress those meta tags. If you know one, your insights are most welcome. Please, just tell me what I missed and which setting to tweak to suppress the tag(s). Regards -- Alexander Kriegisch https://scrum-master.de Michael Osipov schrieb am 01.03.2024 um 21:37: > On 2024/03/01 15:34:42 Alexander Kriegisch wrote: >> Sorry for replying slowly due to intercontinental travel. >> >> What sebb said is just one issue. The other, even more obviuous one is >> that a timestamp is a tinmestamp is a timestamp and hence therefore >> changes each time I generate the site. > > Which exact? The generation date can be skipped, there are no other > skin-supplied dates or timestamps embedded. > > M > > - > To unsubscribe, e-mail: users-unsubscr...@maven.apache.org > For additional commands, e-mail: users-h...@maven.apache.org > - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
On 2024/03/02 06:44:17 Alexander Kriegisch wrote: > Michael, > > did you read my original message? Everything is described quite > precisely and concisely there. > > > I already use this in my site.xml: > > > > > > > > true > > > > > > > > Unfortunately, I found no way to suppress these generated tags on each > > single page: > > > > > > > > I.e., that setting does *not* stop timestamp meta tags from being > generated, only timestamps visible on generated pages. This is why the > subject of this thread is: "How to suppress meta tags 'generator', > 'date' in Doxia Site Renderer?" I was asking, because I was hoping that > somebody could tell me if there were any existing options to suppress > those meta tags. If you know one, your insights are most welcome. > Please, just tell me what I missed and which setting to tweak to > suppress the tag(s). Please provide a sample project for the "date" issue. I does not compile for me logically. Michael - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
Thanks, Michael, for challenging my problem description and asking for a reproducer. When trying to reproduce in a green-field project, skipGenerationDate=true was actually enough to suppress the timestamp meta tag on pages in default formats. As soon, however, as HTML pages generated from asciidoc sources using asciidoctor-maven-plugin come into play, the pages will contain timestamps. I think, I will investigate further in that direction about why that happens and whether it can be suppressed. Cheers -- Alexander Kriegisch https://scrum-master.de Michael Osipov schrieb am 06.03.2024 um 11:57: > On 2024/03/02 06:44:17 Alexander Kriegisch wrote: >> Michael, >> >> did you read my original message? Everything is described quite >> precisely and concisely there. >> >>> I already use this in my site.xml: >>> >>> >>> >>> true >>> >>> >>> >>> Unfortunately, I found no way to suppress these generated tags on each >>> single page: >>> >>> >>> >> >> I.e., that setting does *not* stop timestamp meta tags from being >> generated, only timestamps visible on generated pages. This is why the >> subject of this thread is: "How to suppress meta tags 'generator', >> 'date' in Doxia Site Renderer?" I was asking, because I was hoping that >> somebody could tell me if there were any existing options to suppress >> those meta tags. If you know one, your insights are most welcome. >> Please, just tell me what I missed and which setting to tweak to >> suppress the tag(s). > > Please provide a sample project for the "date" issue. I does not compile for > me logically. > > Michael > > - > To unsubscribe, e-mail: users-unsubscr...@maven.apache.org > For additional commands, e-mail: users-h...@maven.apache.org > - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
To close the issue, here is what I did to suppress all sorts of dates and timestamps in Doxia and Fluido: http://maven.apache.org/DECORATION/1.8.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd";> org.apache.maven.skins maven-fluido-skin 1.11.1 true On top of that, I needed this in my Maven site plugin configuration to also address the same concern specifically in asciidoc pages (look for "docdate" and "docdatetime"): org.apache.maven.plugins maven-site-plugin 3.12.1 org.asciidoctor asciidoctor-maven-plugin 2.2.6 org.asciidoctor asciidoctorj-diagram 2.3.0 false true false en UTF-8 UTF-8 asciidoctor-diagram HTH. Thanks to all of you for your support. Cheers -- Alexander Kriegisch https://scrum-master.de Alexander Kriegisch schrieb am 07.03.2024 um 11:24: > Thanks, Michael, > > for challenging my problem description and asking for a reproducer. When > trying to reproduce in a green-field project, skipGenerationDate=true > was actually enough to suppress the timestamp meta tag on pages in > default formats. As soon, however, as HTML pages generated from asciidoc > sources using asciidoctor-maven-plugin come into play, the pages will > contain timestamps. I think, I will investigate further in that > direction about why that happens and whether it can be suppressed. > > > Michael Osipov schrieb am 06.03.2024 um 11:57: >> On 2024/03/02 06:44:17 Alexander Kriegisch wrote: >>> Michael, >>> >>> did you read my original message? Everything is described quite >>> precisely and concisely there. >>> I already use this in my site.xml: true Unfortunately, I found no way to suppress these generated tags on each single page: >>> >>> I.e., that setting does *not* stop timestamp meta tags from being >>> generated, only timestamps visible on generated pages. This is why the >>> subject of this thread is: "How to suppress meta tags 'generator', >>> 'date' in Doxia Site Renderer?" I was asking, because I was hoping that >>> somebody could tell me if there were any existing options to suppress >>> those meta tags. If you know one, your insights are most welcome. >>> Please, just tell me what I missed and which setting to tweak to >>> suppress the tag(s). >> >> Please provide a sample project for the "date" issue. I does not compile for >> me logically. - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
On 2024/03/07 10:24:07 Alexander Kriegisch wrote: > Thanks, Michael, > > for challenging my problem description and asking for a reproducer. When > trying to reproduce in a green-field project, skipGenerationDate=true > was actually enough to suppress the timestamp meta tag on pages in > default formats. As soon, however, as HTML pages generated from asciidoc > sources using asciidoctor-maven-plugin come into play, the pages will > contain timestamps. I think, I will investigate further in that > direction about why that happens and whether it can be suppressed. You should have mentioned Asciidoctor much much earlier then I would have told you that it completely circumvents the Doxia Sink API and does its own thing with direct passthrough. Therefore, the output is out of our control. Michael - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
I would have mentioned Asciidoctor, had I believed that it was related to the problem. Besides, the Doxia version in the 'generator' tag is Doxia-related and so is the 'date' one. So, it came as somewhat of a surprise that Asciidoctor, while not messing with the former, overrules the setting for the latter, because it has its own timestamp setting. That it has it makes sense, because it is also a stand-alone docs generator with Doxia out of the picture. That setting just happens to write the identical tag. It was hard to diagnose, so it took me a while. Do you think, you can do something about making the Doxia version or the whole 'generator' tag optional? Regards -- Alexander Kriegisch https://scrum-master.de Michael Osipov schrieb am 08.03.2024 um 20:48: > On 2024/03/07 10:24:07 Alexander Kriegisch wrote: >> Thanks, Michael, >> >> for challenging my problem description and asking for a reproducer. When >> trying to reproduce in a green-field project, skipGenerationDate=true >> was actually enough to suppress the timestamp meta tag on pages in >> default formats. As soon, however, as HTML pages generated from asciidoc >> sources using asciidoctor-maven-plugin come into play, the pages will >> contain timestamps. I think, I will investigate further in that >> direction about why that happens and whether it can be suppressed. > > You should have mentioned Asciidoctor much much earlier then I would have > told you that it completely circumvents the Doxia Sink API and does its own > thing with direct passthrough. Therefore, the output is out of our control. - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: How to suppress meta tags 'generator', 'date' in Doxia Site Renderer?
Yes, read here please: https://lists.apache.org/thread/vj7twmhm4b10zk0smko4tw8b4klto4bj On 2024/03/09 08:26:10 Alexander Kriegisch wrote: > I would have mentioned Asciidoctor, had I believed that it was related > to the problem. Besides, the Doxia version in the 'generator' tag is > Doxia-related and so is the 'date' one. So, it came as somewhat of a > surprise that Asciidoctor, while not messing with the former, overrules > the setting for the latter, because it has its own timestamp setting. > That it has it makes sense, because it is also a stand-alone docs > generator with Doxia out of the picture. That setting just happens to > write the identical tag. It was hard to diagnose, so it took me a while. > > Do you think, you can do something about making the Doxia version or the > whole 'generator' tag optional? > > Regards > -- > Alexander Kriegisch > https://scrum-master.de > > > Michael Osipov schrieb am 08.03.2024 um 20:48: > > On 2024/03/07 10:24:07 Alexander Kriegisch wrote: > >> Thanks, Michael, > >> > >> for challenging my problem description and asking for a reproducer. When > >> trying to reproduce in a green-field project, skipGenerationDate=true > >> was actually enough to suppress the timestamp meta tag on pages in > >> default formats. As soon, however, as HTML pages generated from asciidoc > >> sources using asciidoctor-maven-plugin come into play, the pages will > >> contain timestamps. I think, I will investigate further in that > >> direction about why that happens and whether it can be suppressed. > > > > You should have mentioned Asciidoctor much much earlier then I would have > > told you that it completely circumvents the Doxia Sink API and does its own > > thing with direct passthrough. Therefore, the output is out of our control. > > - > To unsubscribe, e-mail: users-unsubscr...@maven.apache.org > For additional commands, e-mail: users-h...@maven.apache.org > > - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org