You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Abel Salgado Romero <ab...@gmail.com> on 2024/10/22 19:44:34 UTC
Getting output directory in Doxia Parser
Hi,
To fix an integration issue in
https://github.com/asciidoctor/asciidoctor-maven-plugin/blob/main/asciidoctor-converter-doxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java,
we'd need to know the target directory where a site page will be stored.
With that we'd be able to adjust some configuration so other files
generated from Asciidoctor can be correctly placed.
After checking the code and from previous conversations (
https://issues.apache.org/jira/browse/DOXIA-614) related to the "reference"
argument, I am quite sure it's not possible to get.
It's a shame I was not working on this before Doxia final v2.0.0 was
released, but now that is out, I'd like to discuss options.
The information is available 2 calls above in
https://github.com/apache/maven-doxia-sitetools/blob/cd77672ba79e1ee42f16258706fc6a43c898b842/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java#L300-L302
.
My first suggestion would be to add outputDir to siteRenderingContext, and
pass it to the `parse` method instead of the reference. But I imagine that
would need to wait for Doxia 3.0.0 right?
Any suggestion or idea? Thanks!
Re: Getting output directory in Doxia Parser
Posted by Abel Salgado Romero <ab...@gmail.com>.
Done, thanks!
https://issues.apache.org/jira/browse/DOXIA-755
I hope "we" incudes me :D
On Mon, Oct 28, 2024 at 9:46 AM Michael Osipov <mi...@apache.org> wrote:
> Please raise a JIRA issue and we'll see what we can do.
>
> On 2024/10/25 13:25:03 Abel Salgado Romero wrote:
> > The "render" method only deals with files as far as I see, but even if we
> > want to abstract, we could have some "Reference" interface with multiple
> > implementations.
> > My concern really, is what can and what should not be added to such
> object.
> > At least to me it should contain the source reference as we pass now and
> > the output path, but I sure other things can come in handy like project
> > defined properties.
> >
> > For more context, I am trying to fix an issue with images generated from
> > the content of a page (with asciidoctor-diagram to be precise).
> > The images are generated by default next to the source file by another
> > process. Unless the actual path can be configured, they endup in the
> > sources dir. This can be done in a normal Mojo, but not in the site where
> > the paths are hidden.
> >
> >
> >
> >
> >
> > On Fri, Oct 25, 2024 at 2:31 PM Michael Osipov <mi...@apache.org>
> wrote:
> >
> > > On 2024/10/22 19:44:34 Abel Salgado Romero wrote:
> > > > Hi,
> > > >
> > > > To fix an integration issue in
> > > >
> > >
> https://github.com/asciidoctor/asciidoctor-maven-plugin/blob/main/asciidoctor-converter-doxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java
> > > ,
> > > > we'd need to know the target directory where a site page will be
> stored.
> > > > With that we'd be able to adjust some configuration so other files
> > > > generated from Asciidoctor can be correctly placed.
> > > > After checking the code and from previous conversations (
> > > > https://issues.apache.org/jira/browse/DOXIA-614) related to the
> > > "reference"
> > > > argument, I am quite sure it's not possible to get.
> > > >
> > > > It's a shame I was not working on this before Doxia final v2.0.0 was
> > > > released, but now that is out, I'd like to discuss options.
> > > > The information is available 2 calls above in
> > > >
> > >
> https://github.com/apache/maven-doxia-sitetools/blob/cd77672ba79e1ee42f16258706fc6a43c898b842/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java#L300-L302
> > > > .
> > > > My first suggestion would be to add outputDir to
> siteRenderingContext,
> > > and
> > > > pass it to the `parse` method instead of the reference. But I imagine
> > > that
> > > > would need to wait for Doxia 3.0.0 right?
> > > >
> > > > Any suggestion or idea? Thanks!
> > >
> > > While I haven't fully checked one of the reasons is that the from API
> PoV
> > > there is no guarantee that the sink you have is backed by a file, could
> > > also be memory or remote socket...
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > > For additional commands, e-mail: users-help@maven.apache.org
> > >
> > >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
>
>
Re: Getting output directory in Doxia Parser
Posted by Michael Osipov <mi...@apache.org>.
Please raise a JIRA issue and we'll see what we can do.
On 2024/10/25 13:25:03 Abel Salgado Romero wrote:
> The "render" method only deals with files as far as I see, but even if we
> want to abstract, we could have some "Reference" interface with multiple
> implementations.
> My concern really, is what can and what should not be added to such object.
> At least to me it should contain the source reference as we pass now and
> the output path, but I sure other things can come in handy like project
> defined properties.
>
> For more context, I am trying to fix an issue with images generated from
> the content of a page (with asciidoctor-diagram to be precise).
> The images are generated by default next to the source file by another
> process. Unless the actual path can be configured, they endup in the
> sources dir. This can be done in a normal Mojo, but not in the site where
> the paths are hidden.
>
>
>
>
>
> On Fri, Oct 25, 2024 at 2:31 PM Michael Osipov <mi...@apache.org> wrote:
>
> > On 2024/10/22 19:44:34 Abel Salgado Romero wrote:
> > > Hi,
> > >
> > > To fix an integration issue in
> > >
> > https://github.com/asciidoctor/asciidoctor-maven-plugin/blob/main/asciidoctor-converter-doxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java
> > ,
> > > we'd need to know the target directory where a site page will be stored.
> > > With that we'd be able to adjust some configuration so other files
> > > generated from Asciidoctor can be correctly placed.
> > > After checking the code and from previous conversations (
> > > https://issues.apache.org/jira/browse/DOXIA-614) related to the
> > "reference"
> > > argument, I am quite sure it's not possible to get.
> > >
> > > It's a shame I was not working on this before Doxia final v2.0.0 was
> > > released, but now that is out, I'd like to discuss options.
> > > The information is available 2 calls above in
> > >
> > https://github.com/apache/maven-doxia-sitetools/blob/cd77672ba79e1ee42f16258706fc6a43c898b842/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java#L300-L302
> > > .
> > > My first suggestion would be to add outputDir to siteRenderingContext,
> > and
> > > pass it to the `parse` method instead of the reference. But I imagine
> > that
> > > would need to wait for Doxia 3.0.0 right?
> > >
> > > Any suggestion or idea? Thanks!
> >
> > While I haven't fully checked one of the reasons is that the from API PoV
> > there is no guarantee that the sink you have is backed by a file, could
> > also be memory or remote socket...
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > For additional commands, e-mail: users-help@maven.apache.org
> >
> >
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Getting output directory in Doxia Parser
Posted by Abel Salgado Romero <ab...@gmail.com>.
The "render" method only deals with files as far as I see, but even if we
want to abstract, we could have some "Reference" interface with multiple
implementations.
My concern really, is what can and what should not be added to such object.
At least to me it should contain the source reference as we pass now and
the output path, but I sure other things can come in handy like project
defined properties.
For more context, I am trying to fix an issue with images generated from
the content of a page (with asciidoctor-diagram to be precise).
The images are generated by default next to the source file by another
process. Unless the actual path can be configured, they endup in the
sources dir. This can be done in a normal Mojo, but not in the site where
the paths are hidden.
On Fri, Oct 25, 2024 at 2:31 PM Michael Osipov <mi...@apache.org> wrote:
> On 2024/10/22 19:44:34 Abel Salgado Romero wrote:
> > Hi,
> >
> > To fix an integration issue in
> >
> https://github.com/asciidoctor/asciidoctor-maven-plugin/blob/main/asciidoctor-converter-doxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java
> ,
> > we'd need to know the target directory where a site page will be stored.
> > With that we'd be able to adjust some configuration so other files
> > generated from Asciidoctor can be correctly placed.
> > After checking the code and from previous conversations (
> > https://issues.apache.org/jira/browse/DOXIA-614) related to the
> "reference"
> > argument, I am quite sure it's not possible to get.
> >
> > It's a shame I was not working on this before Doxia final v2.0.0 was
> > released, but now that is out, I'd like to discuss options.
> > The information is available 2 calls above in
> >
> https://github.com/apache/maven-doxia-sitetools/blob/cd77672ba79e1ee42f16258706fc6a43c898b842/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java#L300-L302
> > .
> > My first suggestion would be to add outputDir to siteRenderingContext,
> and
> > pass it to the `parse` method instead of the reference. But I imagine
> that
> > would need to wait for Doxia 3.0.0 right?
> >
> > Any suggestion or idea? Thanks!
>
> While I haven't fully checked one of the reasons is that the from API PoV
> there is no guarantee that the sink you have is backed by a file, could
> also be memory or remote socket...
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
>
>
Re: Getting output directory in Doxia Parser
Posted by Michael Osipov <mi...@apache.org>.
On 2024/10/22 19:44:34 Abel Salgado Romero wrote:
> Hi,
>
> To fix an integration issue in
> https://github.com/asciidoctor/asciidoctor-maven-plugin/blob/main/asciidoctor-converter-doxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java,
> we'd need to know the target directory where a site page will be stored.
> With that we'd be able to adjust some configuration so other files
> generated from Asciidoctor can be correctly placed.
> After checking the code and from previous conversations (
> https://issues.apache.org/jira/browse/DOXIA-614) related to the "reference"
> argument, I am quite sure it's not possible to get.
>
> It's a shame I was not working on this before Doxia final v2.0.0 was
> released, but now that is out, I'd like to discuss options.
> The information is available 2 calls above in
> https://github.com/apache/maven-doxia-sitetools/blob/cd77672ba79e1ee42f16258706fc6a43c898b842/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java#L300-L302
> .
> My first suggestion would be to add outputDir to siteRenderingContext, and
> pass it to the `parse` method instead of the reference. But I imagine that
> would need to wait for Doxia 3.0.0 right?
>
> Any suggestion or idea? Thanks!
While I haven't fully checked one of the reasons is that the from API PoV there is no guarantee that the sink you have is backed by a file, could also be memory or remote socket...
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org