You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Claude Warren <cl...@apache.org> on 2024/06/16 13:58:11 UTC
[doxia] [DISCUSS] adding footnote processing to markdown
There is a standard footnote extension available from flexmark, and I have
a private branch of 1.12.0 that adds it. It seems to work. Is there any
reason not to add this?
I want to use it for some commons collections documentation where I want to
refer to various published papers.
Claude
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@xenei.com>.
Looking through the contribution information, it looks like a jira ticket
is requested and conversation here first. So step one complete... or
mostly so. Now to open the ticket and submit the request.
On Sun, Jun 16, 2024 at 5:40 PM Gary Gregory <ga...@gmail.com> wrote:
> Hi Claude,
>
> A PR might be the smoothest way to move this forward.
>
> Gary
>
> On Sun, Jun 16, 2024 at 10:48 AM Claude Warren <cl...@apache.org> wrote:
> >
> > flexmark is already used by doxia-markdown to perform the markdown
> processing . This is just adding an additional extension from flexmark to
> the ones already used. All are licensed as BSD-2-Clause
> >
> >
> > On 2024/06/16 14:28:03 Gary Gregory wrote:
> > > Do you have a link FTR? Are there licensing issues?
> > >
> > > Gary
> > >
> > > On Sun, Jun 16, 2024, 9:58 AM Claude Warren <cl...@apache.org> wrote:
> > >
> > > > There is a standard footnote extension available from flexmark, and
> I have
> > > > a private branch of 1.12.0 that adds it. It seems to work. Is
> there any
> > > > reason not to add this?
> > > >
> > > > I want to use it for some commons collections documentation where I
> want to
> > > > refer to various published papers.
> > > >
> > > > Claude
> > > >
> > >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
--
LinkedIn: http://www.linkedin.com/in/claudewarren
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Gary Gregory <ga...@gmail.com>.
Hi Claude,
A PR might be the smoothest way to move this forward.
Gary
On Sun, Jun 16, 2024 at 10:48 AM Claude Warren <cl...@apache.org> wrote:
>
> flexmark is already used by doxia-markdown to perform the markdown processing . This is just adding an additional extension from flexmark to the ones already used. All are licensed as BSD-2-Clause
>
>
> On 2024/06/16 14:28:03 Gary Gregory wrote:
> > Do you have a link FTR? Are there licensing issues?
> >
> > Gary
> >
> > On Sun, Jun 16, 2024, 9:58 AM Claude Warren <cl...@apache.org> wrote:
> >
> > > There is a standard footnote extension available from flexmark, and I have
> > > a private branch of 1.12.0 that adds it. It seems to work. Is there any
> > > reason not to add this?
> > >
> > > I want to use it for some commons collections documentation where I want to
> > > refer to various published papers.
> > >
> > > Claude
> > >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@apache.org>.
flexmark is already used by doxia-markdown to perform the markdown processing . This is just adding an additional extension from flexmark to the ones already used. All are licensed as BSD-2-Clause
On 2024/06/16 14:28:03 Gary Gregory wrote:
> Do you have a link FTR? Are there licensing issues?
>
> Gary
>
> On Sun, Jun 16, 2024, 9:58 AM Claude Warren <cl...@apache.org> wrote:
>
> > There is a standard footnote extension available from flexmark, and I have
> > a private branch of 1.12.0 that adds it. It seems to work. Is there any
> > reason not to add this?
> >
> > I want to use it for some commons collections documentation where I want to
> > refer to various published papers.
> >
> > Claude
> >
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Gary Gregory <ga...@gmail.com>.
Do you have a link FTR? Are there licensing issues?
Gary
On Sun, Jun 16, 2024, 9:58 AM Claude Warren <cl...@apache.org> wrote:
> There is a standard footnote extension available from flexmark, and I have
> a private branch of 1.12.0 that adds it. It seems to work. Is there any
> reason not to add this?
>
> I want to use it for some commons collections documentation where I want to
> refer to various published papers.
>
> Claude
>
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Michael Osipov <mi...@apache.org>.
The only remaining task is to update deps and do the actual releases. See: https://cwiki.apache.org/confluence/display/MAVEN/Towards+Doxia+2.0.0+Stack#TowardsDoxia2.0.0Stack-ComponentReleaseOrder
Expect the trail to be complete end of October.
On 2024/10/13 12:45:38 Claude Warren wrote:
> May i assist in the testing / dev. Or are you far enough along that
> bringing in a new head will take to much time away with bringing me op to
> speed?
>
> On Sun 13 Oct 2024, 12:55 Michael Osipov, <mi...@apache.org> wrote:
>
> > On 2024/10/13 11:07:45 Claude Warren wrote:
> > > Now that Doxia 2.0 is out is there something that has to be done to
> > enable
> > > footnotes or are they enabled by default?
> >
> > Wait until next Maven Site Plugin version is released unless you want to
> > fiddle with deps.
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@xenei.com>.
May i assist in the testing / dev. Or are you far enough along that
bringing in a new head will take to much time away with bringing me op to
speed?
On Sun 13 Oct 2024, 12:55 Michael Osipov, <mi...@apache.org> wrote:
> On 2024/10/13 11:07:45 Claude Warren wrote:
> > Now that Doxia 2.0 is out is there something that has to be done to
> enable
> > footnotes or are they enabled by default?
>
> Wait until next Maven Site Plugin version is released unless you want to
> fiddle with deps.
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Michael Osipov <mi...@apache.org>.
On 2024/10/13 11:07:45 Claude Warren wrote:
> Now that Doxia 2.0 is out is there something that has to be done to enable
> footnotes or are they enabled by default?
Wait until next Maven Site Plugin version is released unless you want to fiddle with deps.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@xenei.com>.
Now that Doxia 2.0 is out is there something that has to be done to enable
footnotes or are they enabled by default?
Thanks,
Claude
On Mon, Jul 8, 2024 at 12:31 PM Claude Warren <cl...@xenei.com> wrote:
> Michael,
>
> Thanks for the note.
>
> I am willing to spend some time working on a solution if we can design and
> acceptable one.
>
> Claude
>
> On Sun, Jul 7, 2024 at 4:22 PM Michael Osipov <mi...@apache.org> wrote:
>
>> Am 2024-07-07 um 15:20 schrieb Claude Warren:
>> > In looking at some of the codebase it seems like the markdown processor
>> > could use lazy instantiation by using the init() method. However, I
>> don't
>> > see any way to pass information to the processor.
>> >
>> > Perhaps the org.apache.maven.doxia.module.markdown could have 2
>> > constructors.
>> >
>> >
>> > 1. Takes a file as an argument and processes the file line by line
>> with
>> > each line being the name of an extension to load.
>> > 2. A no-argument constructor that sets up the system as though the
>> > configuration file contained the current list of extensions.
>> >
>> > The Maven Site plugin could then be modified to look for a hidden file
>> in
>> > the markdown directory (.configure perhaps) and if present use that to
>> > construct the MarkdownProcessor.
>> >
>> > Alternatively, an environment variable that specifies the list of
>> > extensions could be used to provide the list during the static
>> > construction. I like the file based approach since the directory of
>> > markdown files would contain the configuration.
>>
>> While I need to think about this here might be a stop-gap solution:
>> I believe that we can use priorities for the same bean id during DI,
>> thus you could drop in your own impl of the parser and it would override
>> ours containing all the config you need. We do this in Resolver.
>>
>> @cstamas, can you shed some light on this for Warren until we can
>> provide something out of the box?
>>
>> Michael
>>
>> > On Mon, Jun 24, 2024 at 2:33 PM Michael Osipov <mi...@apache.org>
>> wrote:
>> >
>> >> I see, you are referring to
>> >>
>> https://github.com/apache/maven-doxia/blob/master/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java#L126-L165
>> >>
>> >> One of the issue is that I personally do not know what the implications
>> >> might be in terms of performance, etc. Are parsers heavy weight or can
>> they
>> >> be created easily? If you have thousands of files and I had reports of
>> >> people that they process tens of thousands of files...
>> >> kwin@ has recently added a generic approach to configure a parser. I
>> >> think if we are going to make this non-static you should pick it up.
>> From
>> >> my PoV we need his expertise to give you a defitive answer.
>> >>
>> >> Downside: That configuration approach is available only for Doxia
>> 2.0.0.
>> >>
>> >> Konrad, can you look into Claude's request and tell us your opinion?
>> >>
>> >> On 2024/06/24 12:46:16 Claude Warren wrote:
>> >>> Michael,
>> >>>
>> >>> Flexmark has a number of extensions available, but both 1.12.0 and
>> >>> 2.0.0-M12 use a static to create the Flexmark parser. It would be
>> nice
>> >> to
>> >>> be able to pass a list of Flexmark extensions to be added to the
>> >> defaults.
>> >>> The only way I can see to do this is to use configuration options and
>> >> make
>> >>> the parser non-static. Would this be acceptable to you?
>> >>>
>> >>> I will start on the work but before I spend a lot of time figuring out
>> >> how
>> >>> to make it work, I want to know if the solution has a chance of being
>> >>> accepted.
>> >>>
>> >>> Claude
>> >>>
>> >>>
>> >>> On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org>
>> >> wrote:
>> >>>
>> >>>> Am 2024-06-16 um 15:58 schrieb Claude Warren:
>> >>>>> There is a standard footnote extension available from flexmark, and
>> I
>> >>>> have
>> >>>>> a private branch of 1.12.0 that adds it. It seems to work. Is
>> >> there any
>> >>>>> reason not to add this?
>> >>>>>
>> >>>>> I want to use it for some commons collections documentation where I
>> >> want
>> >>>> to
>> >>>>> refer to various published papers.
>> >>>>
>> >>>> Please create a JIRA issue, the PR with a test for the feature, but I
>> >>>> won't merge anything into Doxia 1.x anymore because all is focused on
>> >>>> upcoming Doxia 2.0.0 stack.
>> >>>>
>> >>>> Michael
>> >>>>
>> >>>>
>> >>>> ---------------------------------------------------------------------
>> >>>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> >>>> For additional commands, e-mail: dev-help@maven.apache.org
>> >>>>
>> >>>>
>> >>>
>> >>
>> >> ---------------------------------------------------------------------
>> >> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> >> For additional commands, e-mail: dev-help@maven.apache.org
>> >>
>> >>
>> >
>>
>>
>
> --
> LinkedIn: http://www.linkedin.com/in/claudewarren
>
--
LinkedIn: http://www.linkedin.com/in/claudewarren
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@xenei.com>.
Michael,
Thanks for the note.
I am willing to spend some time working on a solution if we can design and
acceptable one.
Claude
On Sun, Jul 7, 2024 at 4:22 PM Michael Osipov <mi...@apache.org> wrote:
> Am 2024-07-07 um 15:20 schrieb Claude Warren:
> > In looking at some of the codebase it seems like the markdown processor
> > could use lazy instantiation by using the init() method. However, I
> don't
> > see any way to pass information to the processor.
> >
> > Perhaps the org.apache.maven.doxia.module.markdown could have 2
> > constructors.
> >
> >
> > 1. Takes a file as an argument and processes the file line by line
> with
> > each line being the name of an extension to load.
> > 2. A no-argument constructor that sets up the system as though the
> > configuration file contained the current list of extensions.
> >
> > The Maven Site plugin could then be modified to look for a hidden file in
> > the markdown directory (.configure perhaps) and if present use that to
> > construct the MarkdownProcessor.
> >
> > Alternatively, an environment variable that specifies the list of
> > extensions could be used to provide the list during the static
> > construction. I like the file based approach since the directory of
> > markdown files would contain the configuration.
>
> While I need to think about this here might be a stop-gap solution:
> I believe that we can use priorities for the same bean id during DI,
> thus you could drop in your own impl of the parser and it would override
> ours containing all the config you need. We do this in Resolver.
>
> @cstamas, can you shed some light on this for Warren until we can
> provide something out of the box?
>
> Michael
>
> > On Mon, Jun 24, 2024 at 2:33 PM Michael Osipov <mi...@apache.org>
> wrote:
> >
> >> I see, you are referring to
> >>
> https://github.com/apache/maven-doxia/blob/master/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java#L126-L165
> >>
> >> One of the issue is that I personally do not know what the implications
> >> might be in terms of performance, etc. Are parsers heavy weight or can
> they
> >> be created easily? If you have thousands of files and I had reports of
> >> people that they process tens of thousands of files...
> >> kwin@ has recently added a generic approach to configure a parser. I
> >> think if we are going to make this non-static you should pick it up.
> From
> >> my PoV we need his expertise to give you a defitive answer.
> >>
> >> Downside: That configuration approach is available only for Doxia 2.0.0.
> >>
> >> Konrad, can you look into Claude's request and tell us your opinion?
> >>
> >> On 2024/06/24 12:46:16 Claude Warren wrote:
> >>> Michael,
> >>>
> >>> Flexmark has a number of extensions available, but both 1.12.0 and
> >>> 2.0.0-M12 use a static to create the Flexmark parser. It would be nice
> >> to
> >>> be able to pass a list of Flexmark extensions to be added to the
> >> defaults.
> >>> The only way I can see to do this is to use configuration options and
> >> make
> >>> the parser non-static. Would this be acceptable to you?
> >>>
> >>> I will start on the work but before I spend a lot of time figuring out
> >> how
> >>> to make it work, I want to know if the solution has a chance of being
> >>> accepted.
> >>>
> >>> Claude
> >>>
> >>>
> >>> On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org>
> >> wrote:
> >>>
> >>>> Am 2024-06-16 um 15:58 schrieb Claude Warren:
> >>>>> There is a standard footnote extension available from flexmark, and I
> >>>> have
> >>>>> a private branch of 1.12.0 that adds it. It seems to work. Is
> >> there any
> >>>>> reason not to add this?
> >>>>>
> >>>>> I want to use it for some commons collections documentation where I
> >> want
> >>>> to
> >>>>> refer to various published papers.
> >>>>
> >>>> Please create a JIRA issue, the PR with a test for the feature, but I
> >>>> won't merge anything into Doxia 1.x anymore because all is focused on
> >>>> upcoming Doxia 2.0.0 stack.
> >>>>
> >>>> Michael
> >>>>
> >>>>
> >>>> ---------------------------------------------------------------------
> >>>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>>> For additional commands, e-mail: dev-help@maven.apache.org
> >>>>
> >>>>
> >>>
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >> For additional commands, e-mail: dev-help@maven.apache.org
> >>
> >>
> >
>
>
--
LinkedIn: http://www.linkedin.com/in/claudewarren
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Michael Osipov <mi...@apache.org>.
Am 2024-07-07 um 15:20 schrieb Claude Warren:
> In looking at some of the codebase it seems like the markdown processor
> could use lazy instantiation by using the init() method. However, I don't
> see any way to pass information to the processor.
>
> Perhaps the org.apache.maven.doxia.module.markdown could have 2
> constructors.
>
>
> 1. Takes a file as an argument and processes the file line by line with
> each line being the name of an extension to load.
> 2. A no-argument constructor that sets up the system as though the
> configuration file contained the current list of extensions.
>
> The Maven Site plugin could then be modified to look for a hidden file in
> the markdown directory (.configure perhaps) and if present use that to
> construct the MarkdownProcessor.
>
> Alternatively, an environment variable that specifies the list of
> extensions could be used to provide the list during the static
> construction. I like the file based approach since the directory of
> markdown files would contain the configuration.
While I need to think about this here might be a stop-gap solution:
I believe that we can use priorities for the same bean id during DI,
thus you could drop in your own impl of the parser and it would override
ours containing all the config you need. We do this in Resolver.
@cstamas, can you shed some light on this for Warren until we can
provide something out of the box?
Michael
> On Mon, Jun 24, 2024 at 2:33 PM Michael Osipov <mi...@apache.org> wrote:
>
>> I see, you are referring to
>> https://github.com/apache/maven-doxia/blob/master/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java#L126-L165
>>
>> One of the issue is that I personally do not know what the implications
>> might be in terms of performance, etc. Are parsers heavy weight or can they
>> be created easily? If you have thousands of files and I had reports of
>> people that they process tens of thousands of files...
>> kwin@ has recently added a generic approach to configure a parser. I
>> think if we are going to make this non-static you should pick it up. From
>> my PoV we need his expertise to give you a defitive answer.
>>
>> Downside: That configuration approach is available only for Doxia 2.0.0.
>>
>> Konrad, can you look into Claude's request and tell us your opinion?
>>
>> On 2024/06/24 12:46:16 Claude Warren wrote:
>>> Michael,
>>>
>>> Flexmark has a number of extensions available, but both 1.12.0 and
>>> 2.0.0-M12 use a static to create the Flexmark parser. It would be nice
>> to
>>> be able to pass a list of Flexmark extensions to be added to the
>> defaults.
>>> The only way I can see to do this is to use configuration options and
>> make
>>> the parser non-static. Would this be acceptable to you?
>>>
>>> I will start on the work but before I spend a lot of time figuring out
>> how
>>> to make it work, I want to know if the solution has a chance of being
>>> accepted.
>>>
>>> Claude
>>>
>>>
>>> On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org>
>> wrote:
>>>
>>>> Am 2024-06-16 um 15:58 schrieb Claude Warren:
>>>>> There is a standard footnote extension available from flexmark, and I
>>>> have
>>>>> a private branch of 1.12.0 that adds it. It seems to work. Is
>> there any
>>>>> reason not to add this?
>>>>>
>>>>> I want to use it for some commons collections documentation where I
>> want
>>>> to
>>>>> refer to various published papers.
>>>>
>>>> Please create a JIRA issue, the PR with a test for the feature, but I
>>>> won't merge anything into Doxia 1.x anymore because all is focused on
>>>> upcoming Doxia 2.0.0 stack.
>>>>
>>>> Michael
>>>>
>>>>
>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>>> For additional commands, e-mail: dev-help@maven.apache.org
>>>>
>>>>
>>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>>
>>
>
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@xenei.com>.
In looking at some of the codebase it seems like the markdown processor
could use lazy instantiation by using the init() method. However, I don't
see any way to pass information to the processor.
Perhaps the org.apache.maven.doxia.module.markdown could have 2
constructors.
1. Takes a file as an argument and processes the file line by line with
each line being the name of an extension to load.
2. A no-argument constructor that sets up the system as though the
configuration file contained the current list of extensions.
The Maven Site plugin could then be modified to look for a hidden file in
the markdown directory (.configure perhaps) and if present use that to
construct the MarkdownProcessor.
Alternatively, an environment variable that specifies the list of
extensions could be used to provide the list during the static
construction. I like the file based approach since the directory of
markdown files would contain the configuration.
Claude
On Mon, Jun 24, 2024 at 2:33 PM Michael Osipov <mi...@apache.org> wrote:
> I see, you are referring to
> https://github.com/apache/maven-doxia/blob/master/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java#L126-L165
>
> One of the issue is that I personally do not know what the implications
> might be in terms of performance, etc. Are parsers heavy weight or can they
> be created easily? If you have thousands of files and I had reports of
> people that they process tens of thousands of files...
> kwin@ has recently added a generic approach to configure a parser. I
> think if we are going to make this non-static you should pick it up. From
> my PoV we need his expertise to give you a defitive answer.
>
> Downside: That configuration approach is available only for Doxia 2.0.0.
>
> Konrad, can you look into Claude's request and tell us your opinion?
>
> On 2024/06/24 12:46:16 Claude Warren wrote:
> > Michael,
> >
> > Flexmark has a number of extensions available, but both 1.12.0 and
> > 2.0.0-M12 use a static to create the Flexmark parser. It would be nice
> to
> > be able to pass a list of Flexmark extensions to be added to the
> defaults.
> > The only way I can see to do this is to use configuration options and
> make
> > the parser non-static. Would this be acceptable to you?
> >
> > I will start on the work but before I spend a lot of time figuring out
> how
> > to make it work, I want to know if the solution has a chance of being
> > accepted.
> >
> > Claude
> >
> >
> > On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org>
> wrote:
> >
> > > Am 2024-06-16 um 15:58 schrieb Claude Warren:
> > > > There is a standard footnote extension available from flexmark, and I
> > > have
> > > > a private branch of 1.12.0 that adds it. It seems to work. Is
> there any
> > > > reason not to add this?
> > > >
> > > > I want to use it for some commons collections documentation where I
> want
> > > to
> > > > refer to various published papers.
> > >
> > > Please create a JIRA issue, the PR with a test for the feature, but I
> > > won't merge anything into Doxia 1.x anymore because all is focused on
> > > upcoming Doxia 2.0.0 stack.
> > >
> > > Michael
> > >
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > > For additional commands, e-mail: dev-help@maven.apache.org
> > >
> > >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
--
LinkedIn: http://www.linkedin.com/in/claudewarren
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Michael Osipov <mi...@apache.org>.
I see, you are referring to https://github.com/apache/maven-doxia/blob/master/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java#L126-L165
One of the issue is that I personally do not know what the implications might be in terms of performance, etc. Are parsers heavy weight or can they be created easily? If you have thousands of files and I had reports of people that they process tens of thousands of files...
kwin@ has recently added a generic approach to configure a parser. I think if we are going to make this non-static you should pick it up. From my PoV we need his expertise to give you a defitive answer.
Downside: That configuration approach is available only for Doxia 2.0.0.
Konrad, can you look into Claude's request and tell us your opinion?
On 2024/06/24 12:46:16 Claude Warren wrote:
> Michael,
>
> Flexmark has a number of extensions available, but both 1.12.0 and
> 2.0.0-M12 use a static to create the Flexmark parser. It would be nice to
> be able to pass a list of Flexmark extensions to be added to the defaults.
> The only way I can see to do this is to use configuration options and make
> the parser non-static. Would this be acceptable to you?
>
> I will start on the work but before I spend a lot of time figuring out how
> to make it work, I want to know if the solution has a chance of being
> accepted.
>
> Claude
>
>
> On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org> wrote:
>
> > Am 2024-06-16 um 15:58 schrieb Claude Warren:
> > > There is a standard footnote extension available from flexmark, and I
> > have
> > > a private branch of 1.12.0 that adds it. It seems to work. Is there any
> > > reason not to add this?
> > >
> > > I want to use it for some commons collections documentation where I want
> > to
> > > refer to various published papers.
> >
> > Please create a JIRA issue, the PR with a test for the feature, but I
> > won't merge anything into Doxia 1.x anymore because all is focused on
> > upcoming Doxia 2.0.0 stack.
> >
> > Michael
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@apache.org>.
Michael,
Flexmark has a number of extensions available, but both 1.12.0 and
2.0.0-M12 use a static to create the Flexmark parser. It would be nice to
be able to pass a list of Flexmark extensions to be added to the defaults.
The only way I can see to do this is to use configuration options and make
the parser non-static. Would this be acceptable to you?
I will start on the work but before I spend a lot of time figuring out how
to make it work, I want to know if the solution has a chance of being
accepted.
Claude
On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org> wrote:
> Am 2024-06-16 um 15:58 schrieb Claude Warren:
> > There is a standard footnote extension available from flexmark, and I
> have
> > a private branch of 1.12.0 that adds it. It seems to work. Is there any
> > reason not to add this?
> >
> > I want to use it for some commons collections documentation where I want
> to
> > refer to various published papers.
>
> Please create a JIRA issue, the PR with a test for the feature, but I
> won't merge anything into Doxia 1.x anymore because all is focused on
> upcoming Doxia 2.0.0 stack.
>
> Michael
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@xenei.com>.
Ahh, thank you for your response. This is a simpel runtime change to the
maven site plugin to add the existing doxia extension. I will start on the
PR shortly.
Claude
On Tue, Jun 18, 2024 at 9:19 AM Michael Osipov <mi...@apache.org> wrote:
> Please create the PR first, maybe it is just a runtime dep for the Maven
> Site Plugin. If if not and modification of Doxia is necessary then one
> needs to release this entire stack to make it proper:
> maven-doxia
> maven-reporting-api
> maven-doxia-sitetools
> maven-reporting-impl
> maven-reporting-exec
> maven-site-plugin
>
> This will take quite some work I am not willing to do for the 1.x branch.
> Maybe someone else can step up.
>
> Michael
> On 2024/06/17 21:15:13 Claude Warren wrote:
> > I understand the focus on Doxia 2.0.0, but since all Apache uses 1.x, is
> > there any way to create a release for 1.x (I can give it a try if there
> is
> > documentation).
> >
> > Also, how different is Doxia 2.0.0 with respect to the flexmark use?
> >
> > Claude
> >
> > On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org>
> wrote:
> >
> > > Am 2024-06-16 um 15:58 schrieb Claude Warren:
> > > > There is a standard footnote extension available from flexmark, and I
> > > have
> > > > a private branch of 1.12.0 that adds it. It seems to work. Is
> there any
> > > > reason not to add this?
> > > >
> > > > I want to use it for some commons collections documentation where I
> want
> > > to
> > > > refer to various published papers.
> > >
> > > Please create a JIRA issue, the PR with a test for the feature, but I
> > > won't merge anything into Doxia 1.x anymore because all is focused on
> > > upcoming Doxia 2.0.0 stack.
> > >
> > > Michael
> > >
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > > For additional commands, e-mail: dev-help@maven.apache.org
> > >
> > >
> >
> > --
> > LinkedIn: http://www.linkedin.com/in/claudewarren
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
--
LinkedIn: http://www.linkedin.com/in/claudewarren
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Michael Osipov <mi...@apache.org>.
Please create the PR first, maybe it is just a runtime dep for the Maven Site Plugin. If if not and modification of Doxia is necessary then one needs to release this entire stack to make it proper:
maven-doxia
maven-reporting-api
maven-doxia-sitetools
maven-reporting-impl
maven-reporting-exec
maven-site-plugin
This will take quite some work I am not willing to do for the 1.x branch. Maybe someone else can step up.
Michael
On 2024/06/17 21:15:13 Claude Warren wrote:
> I understand the focus on Doxia 2.0.0, but since all Apache uses 1.x, is
> there any way to create a release for 1.x (I can give it a try if there is
> documentation).
>
> Also, how different is Doxia 2.0.0 with respect to the flexmark use?
>
> Claude
>
> On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org> wrote:
>
> > Am 2024-06-16 um 15:58 schrieb Claude Warren:
> > > There is a standard footnote extension available from flexmark, and I
> > have
> > > a private branch of 1.12.0 that adds it. It seems to work. Is there any
> > > reason not to add this?
> > >
> > > I want to use it for some commons collections documentation where I want
> > to
> > > refer to various published papers.
> >
> > Please create a JIRA issue, the PR with a test for the feature, but I
> > won't merge anything into Doxia 1.x anymore because all is focused on
> > upcoming Doxia 2.0.0 stack.
> >
> > Michael
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
>
> --
> LinkedIn: http://www.linkedin.com/in/claudewarren
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Claude Warren <cl...@xenei.com>.
I understand the focus on Doxia 2.0.0, but since all Apache uses 1.x, is
there any way to create a release for 1.x (I can give it a try if there is
documentation).
Also, how different is Doxia 2.0.0 with respect to the flexmark use?
Claude
On Sun, Jun 16, 2024 at 8:43 PM Michael Osipov <mi...@apache.org> wrote:
> Am 2024-06-16 um 15:58 schrieb Claude Warren:
> > There is a standard footnote extension available from flexmark, and I
> have
> > a private branch of 1.12.0 that adds it. It seems to work. Is there any
> > reason not to add this?
> >
> > I want to use it for some commons collections documentation where I want
> to
> > refer to various published papers.
>
> Please create a JIRA issue, the PR with a test for the feature, but I
> won't merge anything into Doxia 1.x anymore because all is focused on
> upcoming Doxia 2.0.0 stack.
>
> Michael
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
--
LinkedIn: http://www.linkedin.com/in/claudewarren
Re: [doxia] [DISCUSS] adding footnote processing to markdown
Posted by Michael Osipov <mi...@apache.org>.
Am 2024-06-16 um 15:58 schrieb Claude Warren:
> There is a standard footnote extension available from flexmark, and I have
> a private branch of 1.12.0 that adds it. It seems to work. Is there any
> reason not to add this?
>
> I want to use it for some commons collections documentation where I want to
> refer to various published papers.
Please create a JIRA issue, the PR with a test for the feature, but I
won't merge anything into Doxia 1.x anymore because all is focused on
upcoming Doxia 2.0.0 stack.
Michael
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org