Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Aldrin Leal
There's a great comprehensive list at http://staticsitegenerators.net

(btw, I've wrote the jbake-maven-plugin, for jbake -
https://github.com/jonbullock/JBake)

--
-- Aldrin Leal, 
Master your EC2-fu! Get the latest ekaterminal public beta
http://www.ingenieux.com.br/products/ekaterminal/


On Sun, Oct 6, 2013 at 12:20 PM, Jason van Zyl  wrote:

> Here's a pretty good list of tools. The other two I've tried are Marked
> (which is another MAC app), but I've also tried dillinger.io which is
> web-based editor and it's quite good. There are quite a few web-based tools
> that provide similar capabilities to Mou.
>
> http://mashable.com/2013/06/24/markdown-tools/
>
> On Oct 5, 2013, at 11:19 AM, Jason van Zyl  wrote:
>
> > We current have multiple formats for our site documentation and two of
> them no one else in the world uses except us. We created xdoc here a long
> time ago in the Jakarta project, and APT has lost in the world of markup. I
> ported it from another project many years ago but there are many better
> options like asciidoc, restructured text, and markdown. My preference is
> for markdown but I would like to get rid of xdoc, fml, and xdoc and convert
> that documentation over to markdown. The tool support is great for editing,
> book support is great (the Pro Git book is created from markdown). We can
> still use all the Doxia tools for all the post processing. But I see no
> need to 4 different types of markup for the site, and honestly I find
> working with APT now incredibly annoying.
> >
> > I'm happy to do the conversion and testing.
> >
> > Thanks,
> >
> > Jason
> >
> > --
> > Jason van Zyl
> > Founder,  Apache Maven
> > http://twitter.com/jvanzyl
> > -
> >
> >
> >
> >
> >
> >
> >
>
> Thanks,
>
> Jason
>
> --
> Jason van Zyl
> Founder,  Apache Maven
> http://twitter.com/jvanzyl
> -
>
>
>
>
>
>
>
>


Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Jason van Zyl
Here's a pretty good list of tools. The other two I've tried are Marked (which 
is another MAC app), but I've also tried dillinger.io which is web-based editor 
and it's quite good. There are quite a few web-based tools that provide similar 
capabilities to Mou.

http://mashable.com/2013/06/24/markdown-tools/

On Oct 5, 2013, at 11:19 AM, Jason van Zyl  wrote:

> We current have multiple formats for our site documentation and two of them 
> no one else in the world uses except us. We created xdoc here a long time ago 
> in the Jakarta project, and APT has lost in the world of markup. I ported it 
> from another project many years ago but there are many better options like 
> asciidoc, restructured text, and markdown. My preference is for markdown but 
> I would like to get rid of xdoc, fml, and xdoc and convert that documentation 
> over to markdown. The tool support is great for editing, book support is 
> great (the Pro Git book is created from markdown). We can still use all the 
> Doxia tools for all the post processing. But I see no need to 4 different 
> types of markup for the site, and honestly I find working with APT now 
> incredibly annoying.
> 
> I'm happy to do the conversion and testing.
> 
> Thanks,
> 
> Jason
> 
> --
> Jason van Zyl
> Founder,  Apache Maven
> http://twitter.com/jvanzyl
> -
> 
> 
> 
> 
> 
> 
> 

Thanks,

Jason

--
Jason van Zyl
Founder,  Apache Maven
http://twitter.com/jvanzyl
-









RE: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Tanveer Ahmad
Please remove me from mailing list

Tanveer Ahmad

Lecturer, School of Technology
St Patricks International College
48 Carey Street
New Court
London
WC2A 2JE
United Kingdom
www.st-patricks.ac.uk



From: sebb 
Sent: 06 October 2013 13:16
To: Maven Developers List
Subject: Re: [DISCUSS] Converting site documentation to Markdown

Regarding automatic conversion to Markdown:

The main ASF site was converted from xdoc to Markdown. Some tools werr
written for this, but they were not 100% accurate; we were still
finding conversion issues a year or so later. [We've probably not
found them all yet] Whether these conversion issues are important is
another matter, but there are certainly some area such as the license
pages where it is vital that the conversion is accurate -- and
problems were found there.

AFAIR, Markdown still has some areas where it is weak - for example
numeric lists, which was one of the license page issues.

The existing HTML documentation is presumably all in SCM, so it should
be possible to compare the new with the old if necessary.
And if layout etc problems are detected later, the originals should be
available.

Might be worth creating tags for the source and generated HTML just
before and after conversion to make it easier to dig into the history
later.


On 6 October 2013 10:13, Kristian Rosenvold
 wrote:
> 2013/10/6 Stephen Connolly :
>>> IMHO
>>>
>>> Betamax == AsciiDoc
>>> VHS == MarkDown
>
> Being a bunch of old geezers, we all know which was technically superior.
>
> I had to teach my oldest kid how to operate a non-mobile phone the
> other day (she dialled number before lifting the handset)
>
> Kristian
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
> For additional commands, e-mail: dev-h...@maven.apache.org
>

-
To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
For additional commands, e-mail: dev-h...@maven.apache.org


-
To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
For additional commands, e-mail: dev-h...@maven.apache.org



Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread sebb
Regarding automatic conversion to Markdown:

The main ASF site was converted from xdoc to Markdown. Some tools werr
written for this, but they were not 100% accurate; we were still
finding conversion issues a year or so later. [We've probably not
found them all yet] Whether these conversion issues are important is
another matter, but there are certainly some area such as the license
pages where it is vital that the conversion is accurate -- and
problems were found there.

AFAIR, Markdown still has some areas where it is weak - for example
numeric lists, which was one of the license page issues.

The existing HTML documentation is presumably all in SCM, so it should
be possible to compare the new with the old if necessary.
And if layout etc problems are detected later, the originals should be
available.

Might be worth creating tags for the source and generated HTML just
before and after conversion to make it easier to dig into the history
later.


On 6 October 2013 10:13, Kristian Rosenvold
 wrote:
> 2013/10/6 Stephen Connolly :
>>> IMHO
>>>
>>> Betamax == AsciiDoc
>>> VHS == MarkDown
>
> Being a bunch of old geezers, we all know which was technically superior.
>
> I had to teach my oldest kid how to operate a non-mobile phone the
> other day (she dialled number before lifting the handset)
>
> Kristian
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
> For additional commands, e-mail: dev-h...@maven.apache.org
>

-
To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
For additional commands, e-mail: dev-h...@maven.apache.org



Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Hervé BOUTEMY
FML is used in a few places, not only main sites [1] but plugins and 
components too [2]

So perhaps FML will remain until we find some macro tooling.
I prefer keeping FML than maintaing index by hand

If we can replace apt and xdoc, that will already be a good step

Regards,

Hervé

[1] http://maven.apache.org/doxia/faq.html

[2] http://maven.apache.org/plugins/maven-site-plugin/faq.html

Le samedi 5 octobre 2013 23:31:17 Jason van Zyl a écrit :
> I'm not saying we tell people not to use it, but for us I don't think it's
> an issue. It's been years since anything significant has been added to our
> FAQ and they are few enough that they can be converted by hand to add a
> TOC. I just want to make working with our documentation a little more
> enjoyable and amenable to pull requests.
> On Oct 5, 2013, at 5:52 PM, Robert Scholte  wrote:
> > https://jira.codehaus.org/browse/DOXIA-472 ? No, still not fixed.
> > 
> > IMHO the fml can only be replaced if there's a macro to generate an index
> > of all the questions.
> > 
> > Robert
> > 
> > Op Sat, 05 Oct 2013 22:59:42 +0200 schreef Stephen Connolly 
:
> >> Has the page title problem been fixed?
> >> 
> >> Last I checked you could not set the page title that Doxia generates for
> >> HTML pages generated from markdown
> >> 
> >> (Crosses fingers that it is fixed)
> >> 
> >> On Saturday, 5 October 2013, Jason van Zyl wrote:
> >>> We current have multiple formats for our site documentation and two of
> >>> them no one else in the world uses except us. We created xdoc here a
> >>> long
> >>> time ago in the Jakarta project, and APT has lost in the world of
> >>> markup. I
> >>> ported it from another project many years ago but there are many better
> >>> options like asciidoc, restructured text, and markdown. My preference is
> >>> for markdown but I would like to get rid of xdoc, fml, and xdoc and
> >>> convert
> >>> that documentation over to markdown. The tool support is great for
> >>> editing,
> >>> book support is great (the Pro Git book is created from markdown). We
> >>> can
> >>> still use all the Doxia tools for all the post processing. But I see no
> >>> need to 4 different types of markup for the site, and honestly I find
> >>> working with APT now incredibly annoying.
> >>> 
> >>> I'm happy to do the conversion and testing.
> >>> 
> >>> Thanks,
> >>> 
> >>> Jason
> >>> 
> >>> --
> >>> Jason van Zyl
> >>> Founder,  Apache Maven
> >>> http://twitter.com/jvanzyl
> >>> -
> > 
> > -
> > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
> > For additional commands, e-mail: dev-h...@maven.apache.org
> 
> Thanks,
> 
> Jason
> 
> --
> Jason van Zyl
> Founder,  Apache Maven
> http://twitter.com/jvanzyl
> -

-
To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
For additional commands, e-mail: dev-h...@maven.apache.org



Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Hervé BOUTEMY
ok for the rationale
Markdown seems to have been chosen in Apache CMS too [1]
DOXIA-472 is a show stopper IMHO for the moment: I hope someone will fix it

Stephen wrote about asciidoc, but it is not supported by Doxia at the moment 
[2], so not an option until someone adds this format to Doxia

For conversion, if someone write a Markdown Sink, doxia-converter [3] is 
already available to convert any Doxia-parser-supported format to Doxia-sink-
supported format.


then can we share on the tools for editing?
>From the dicsussion, I understand that Mac users have Mou http://mouapp.com/, 
with side-by-side edit/render: really nice
But I don't have a Mac.
There are many online Markdown editors, but we need something local.
Any good tool for Linux, ie my OS? Any experience with major IDEs: Eclipse, 
Netbeans, Idea?

Notice I couldn't edit our Maven website Markdown content with CMS and any 
editor enhancement: does anybody know what is wrong with our content?

Regards,

Hervé


[1] http://www.apache.org/dev/cms.html#markdown

[2] http://maven.apache.org/doxia/references/index.html

[3] http://maven.apache.org/doxia/doxia-tools/doxia-converter/

Le samedi 5 octobre 2013 11:19:01 Jason van Zyl a écrit :
> We current have multiple formats for our site documentation and two of them
> no one else in the world uses except us. We created xdoc here a long time
> ago in the Jakarta project, and APT has lost in the world of markup. I
> ported it from another project many years ago but there are many better
> options like asciidoc, restructured text, and markdown. My preference is
> for markdown but I would like to get rid of xdoc, fml, and xdoc and convert
> that documentation over to markdown. The tool support is great for editing,
> book support is great (the Pro Git book is created from markdown). We can
> still use all the Doxia tools for all the post processing. But I see no
> need to 4 different types of markup for the site, and honestly I find
> working with APT now incredibly annoying.
> 
> I'm happy to do the conversion and testing.
> 
> Thanks,
> 
> Jason
> 
> --
> Jason van Zyl
> Founder,  Apache Maven
> http://twitter.com/jvanzyl
> -

-
To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
For additional commands, e-mail: dev-h...@maven.apache.org



Re: Maven Core moving to 1.6

2013-10-06 Thread Stephane Nicoll
Yep, +1 for 3.2 and onward.

S.


On Sat, Oct 5, 2013 at 5:03 AM, Jason van Zyl  wrote:

> Given the vote we had about releases after September does anyone mind if I
> update the source/target levels to 1.6 for the core?
>
> Thanks,
>
> Jason
>
> --
> Jason van Zyl
> Founder,  Apache Maven
> http://twitter.com/jvanzyl
> -
>
>
>
>
>
>
>
>


Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Kristian Rosenvold
2013/10/6 Stephen Connolly :
>> IMHO
>>
>> Betamax == AsciiDoc
>> VHS == MarkDown

Being a bunch of old geezers, we all know which was technically superior.

I had to teach my oldest kid how to operate a non-mobile phone the
other day (she dialled number before lifting the handset)

Kristian

-
To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
For additional commands, e-mail: dev-h...@maven.apache.org



Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Jason van Zyl

On Oct 6, 2013, at 3:13 AM, Mirko Friedenhagen  wrote:

> Hello there,
> 
> just my 2 cents:
> 
> * I do not understand what is that bad about xdoc which is almost HTML. And
> having a XSD/DTD code completion is available.
> 

It's not bad, per se. It's really about the prevalence of good editors. I don't 
much find the XSD/DTD of much benefit in contrast to editors like Mou where I 
have the raw content on the left, rendered content on the right, I can edit 
diagrams, reload and iterate. 

> * *All* freestyle markup languages are ugly and hard to remember (I have to
> use TWiki/FosWiki and JIRA inhouse)
> 
> * So getting rid of APT looks like a good idea but to be consistent with
> Wiki/JIRA of Maven I could imagine Confluence to be a better choice.
> 
> Regards Mirko
> -- 
> Sent from my mobile
> On Oct 6, 2013 5:31 AM, "Jason van Zyl"  wrote:
> 
>> I'm not saying we tell people not to use it, but for us I don't think it's
>> an issue. It's been years since anything significant has been added to our
>> FAQ and they are few enough that they can be converted by hand to add a
>> TOC. I just want to make working with our documentation a little more
>> enjoyable and amenable to pull requests.
>> 
>> On Oct 5, 2013, at 5:52 PM, Robert Scholte  wrote:
>> 
>>> https://jira.codehaus.org/browse/DOXIA-472 ? No, still not fixed.
>>> 
>>> IMHO the fml can only be replaced if there's a macro to generate an
>> index of all the questions.
>>> 
>>> Robert
>>> 
>>> Op Sat, 05 Oct 2013 22:59:42 +0200 schreef Stephen Connolly <
>> stephen.alan.conno...@gmail.com>:
>>> 
 Has the page title problem been fixed?
 
 Last I checked you could not set the page title that Doxia generates for
 HTML pages generated from markdown
 
 (Crosses fingers that it is fixed)
 
 On Saturday, 5 October 2013, Jason van Zyl wrote:
 
> We current have multiple formats for our site documentation and two of
> them no one else in the world uses except us. We created xdoc here a
>> long
> time ago in the Jakarta project, and APT has lost in the world of
>> markup. I
> ported it from another project many years ago but there are many better
> options like asciidoc, restructured text, and markdown. My preference
>> is
> for markdown but I would like to get rid of xdoc, fml, and xdoc and
>> convert
> that documentation over to markdown. The tool support is great for
>> editing,
> book support is great (the Pro Git book is created from markdown). We
>> can
> still use all the Doxia tools for all the post processing. But I see no
> need to 4 different types of markup for the site, and honestly I find
> working with APT now incredibly annoying.
> 
> I'm happy to do the conversion and testing.
> 
> Thanks,
> 
> Jason
> 
> --
> Jason van Zyl
> Founder,  Apache Maven
> http://twitter.com/jvanzyl
> -
> 
> 
> 
> 
> 
> 
> 
> 
>>> 
>>> -
>>> To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
>>> For additional commands, e-mail: dev-h...@maven.apache.org
>>> 
>> 
>> Thanks,
>> 
>> Jason
>> 
>> --
>> Jason van Zyl
>> Founder,  Apache Maven
>> http://twitter.com/jvanzyl
>> -
>> 
>> 
>> 
>> 
>> 
>> 
>> 
>> 

Thanks,

Jason

--
Jason van Zyl
Founder,  Apache Maven
http://twitter.com/jvanzyl
-









Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Stephen Connolly


Sent from my iPhone

> On 6 Oct 2013, at 08:44, Stephen Connolly  
> wrote:
> 
> 
> 
>> On Sunday, 6 October 2013, Mirko Friedenhagen wrote:
>> Hello there,
>> 
>> just my 2 cents:
>> 
>> * I do not understand what is that bad about xdoc which is almost HTML. And
>> having a XSD/DTD code completion is available.
> 
> It's ugly (remember beauty is in the eye of the beholder)
>  
>> 
>> * *All* freestyle markup languages are ugly and hard to remember (I have to
>> use TWiki/FosWiki and JIRA inhouse)
> 
> Markdown and asciidoc are not ugly. Markdown ends up looking almost the same 
> as you'd format in plain text if you didn't have a markup language.
> 
> Asciidoc is similar, it has the advantage of actually having a specification 
> and a 1:1 bijection with docbook, however the full feature set if docbook can 
> make it more ugly and you can need to look up some of the more obscure 
> features.
> 
> If I was choosing to write a technical book I would choose asciidoc.
> 
> For smaller pages like what we have, markdown is perfect as you don't need 
> the full docbook feature set... 
> 
> IMHO
> 
> Betamax == AsciiDoc
> VHS == MarkDown
> 
> AsciiDoc is the technically superior product that may well loose out to the 
> more popular markdown.
> 
> For our content there will be virtually no difference between the two and 
> right now there are better editors for markdown (eg I like iaWriter on the 
> mac/iPhone/iPad) and GitHub has editor support for markdown (afaik it 
> supports rendering asciidoc but I don't think they have the same editor 
> support for asciidoc)
> 
> From my PoV until there is a pure JavaScript implementation of an AsciiDoc 
> parser/renderer it will not be able to win the war.

https://github.com/asciidoctor/asciidoctor.js

But I suspect that cross compiling ruby to JavaScript will not lead something 
that JavaScript developers will take up... I could be wrong, but I think a pure 
JavaScript impl using JavaScript API "conventions" would be needed.

FWIW I think the same could be said for Java... But life is too short and 
personally I don't mind sucking in JRuby ;-)

> 
>> 
>> * So getting rid of APT looks like a good idea but to be consistent with
>> Wiki/JIRA of Maven I could imagine Confluence to be a better choice.
> Something like
> 
> https://marketplace.atlassian.com/plugins/com.atlassian.plugins.confluence.markdown.confluence-markdown-macro
> 
> Might be a better option :-)
> 
> (Granted I might be thought biased towards markdown given my recent work on 
> literate builds for Jenkins, but trust me, after writing a parser for 
> extracting literate builds from markdown, asciidoc would be *much* better)
> 
>> 
>> Regards Mirko
>> --
>> Sent from my mobile
>> On Oct 6, 2013 5:31 AM, "Jason van Zyl"  wrote:
>> 
>> > I'm not saying we tell people not to use it, but for us I don't think it's
>> > an issue. It's been years since anything significant has been added to our
>> > FAQ and they are few enough that they can be converted by hand to add a
>> > TOC. I just want to make working with our documentation a little more
>> > enjoyable and amenable to pull requests.
>> >
>> > On Oct 5, 2013, at 5:52 PM, Robert Scholte  wrote:
>> >
>> > > https://jira.codehaus.org/browse/DOXIA-472 ? No, still not fixed.
>> > >
>> > > IMHO the fml can only be replaced if there's a macro to generate an
>> > index of all the questions.
>> > >
>> > > Robert
>> > >
>> > > Op Sat, 05 Oct 2013 22:59:42 +0200 schreef Stephen Connolly <
>> > stephen.alan.conno...@gmail.com>:
>> > >
>> > >> Has the page title problem been fixed?
>> > >>
>> > >> Last I checked you could not set the page title that Doxia generates for
>> > >> HTML pages generated from markdown
>> > >>
>> > >> (Crosses fingers that it is fixed)
>> > >>
>> > >> On Saturday, 5 October 2013, Jason van Zyl wrote:
>> > >>
>> > >>> We current have multiple formats for our site documentation and two of
>> > >>> them no one else in the world uses except us. We created xdoc here a
>> > long
>> > >>> time ago in the Jakarta project, and APT has lost in the world of
>> > markup. I
>> > >>> ported it from another project many years ago but there are many better
>> > >>> options like asciidoc, restructured text, and markdown. My preference
>> > is
>> > >>> for markdown but I would like to get rid of xdoc, fml, and xdoc and
>> > convert
>> > >>> that documentation over to markdown. The tool support is great for
>> > editing,
>> > >>> book support is great (the Pro Git book is created from markdown). We
>> > can
>> > >>> still use all the Doxia tools for all the post processing. But I see no
>> > >>> need to 4 different types of markup for the site, and honestly I find
>> > >>> working with APT now incredibly annoying.
>> > >>>
>> > >>> I'm happy to do the conversion and testing.
>> > >>>
>> > >>> Thanks,
>> > >>>
>> > >>> Jason
>> > >>>
>> > >>> --
>> > >>> Jason van Zyl
>> > >>> Founder,  Apache Maven
>> > >>> 

[DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Stephen Connolly
On Sunday, 6 October 2013, Mirko Friedenhagen wrote:

> Hello there,
>
> just my 2 cents:
>
> * I do not understand what is that bad about xdoc which is almost HTML. And
> having a XSD/DTD code completion is available.


It's ugly (remember beauty is in the eye of the beholder)


>
> * *All* freestyle markup languages are ugly and hard to remember (I have to
> use TWiki/FosWiki and JIRA inhouse)


Markdown and asciidoc are not ugly. Markdown ends up looking almost the
same as you'd format in plain text if you didn't have a markup language.

Asciidoc is similar, it has the advantage of actually having a
specification and a 1:1 bijection with docbook, however the full feature
set if docbook can make it more ugly and you can need to look up some of
the more obscure features.

If I was choosing to write a technical book I would choose asciidoc.

For smaller pages like what we have, markdown is perfect as you don't need
the full docbook feature set...

IMHO

Betamax == AsciiDoc
VHS == MarkDown

AsciiDoc is the technically superior product that may well loose out to the
more popular markdown.

For our content there will be virtually no difference between the two and
right now there are better editors for markdown (eg I like iaWriter on the
mac/iPhone/iPad) and GitHub has editor support for markdown (afaik it
supports rendering asciidoc but I don't think they have the same editor
support for asciidoc)

>From my PoV until there is a pure JavaScript implementation of an AsciiDoc
parser/renderer it will not be able to win the war.


> * So getting rid of APT looks like a good idea but to be consistent with
> Wiki/JIRA of Maven I could imagine Confluence to be a better choice.

Something like

https://marketplace.atlassian.com/plugins/com.atlassian.plugins.confluence.markdown.confluence-markdown-macro

Might be a better option :-)

(Granted I might be thought biased towards markdown given my recent work on
literate builds for Jenkins, but trust me, after writing a parser for
extracting literate builds from markdown, asciidoc would be *much* better)


> Regards Mirko
> --
> Sent from my mobile
> On Oct 6, 2013 5:31 AM, "Jason van Zyl"  wrote:
>
> > I'm not saying we tell people not to use it, but for us I don't think
> it's
> > an issue. It's been years since anything significant has been added to
> our
> > FAQ and they are few enough that they can be converted by hand to add a
> > TOC. I just want to make working with our documentation a little more
> > enjoyable and amenable to pull requests.
> >
> > On Oct 5, 2013, at 5:52 PM, Robert Scholte  wrote:
> >
> > > https://jira.codehaus.org/browse/DOXIA-472 ? No, still not fixed.
> > >
> > > IMHO the fml can only be replaced if there's a macro to generate an
> > index of all the questions.
> > >
> > > Robert
> > >
> > > Op Sat, 05 Oct 2013 22:59:42 +0200 schreef Stephen Connolly <
> > stephen.alan.conno...@gmail.com>:
> > >
> > >> Has the page title problem been fixed?
> > >>
> > >> Last I checked you could not set the page title that Doxia generates
> for
> > >> HTML pages generated from markdown
> > >>
> > >> (Crosses fingers that it is fixed)
> > >>
> > >> On Saturday, 5 October 2013, Jason van Zyl wrote:
> > >>
> > >>> We current have multiple formats for our site documentation and two
> of
> > >>> them no one else in the world uses except us. We created xdoc here a
> > long
> > >>> time ago in the Jakarta project, and APT has lost in the world of
> > markup. I
> > >>> ported it from another project many years ago but there are many
> better
> > >>> options like asciidoc, restructured text, and markdown. My preference
> > is
> > >>> for markdown but I would like to get rid of xdoc, fml, and xdoc and
> > convert
> > >>> that documentation over to markdown. The tool support is great for
> > editing,
> > >>> book support is great (the Pro Git book is created from markdown). We
> > can
> > >>> still use all the Doxia tools for all the post processing. But I see
> no
> > >>> need to 4 different types of markup for the site, and honestly I find
> > >>> working with APT now incredibly annoying.
> > >>>
> > >>> I'm happy to do the conversion and testing.
> > >>>
> > >>> Thanks,
> > >>>
> > >>> Jason
> > >>>
> > >>> --
> > >>> Jason van Zyl
> > >>> Founder,  Apache Maven
> > >>> http://twitter.com/jvanzyl
> > >>> -
> > >>>
> > >>>
> > >>>
> > >>>
> > >>>
> > >>>
> > >>>
> > >>>
> > >
> > > -
> > > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
> > > For additional commands, e-mail: dev-h...@maven.apache.org
> > >
> >
> > Thanks,
> >
> > Jason
> >
> > --
> > Jason van Zyl
> > Founder,  Apache Maven
> > http://twitter.com/jvanzyl
> > -
> >
> >
> >
> >
> >
> >
> >
> >
>


-- 
Sent f

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Mirko Friedenhagen
Hello there,

just my 2 cents:

* I do not understand what is that bad about xdoc which is almost HTML. And
having a XSD/DTD code completion is available.

* *All* freestyle markup languages are ugly and hard to remember (I have to
use TWiki/FosWiki and JIRA inhouse)

* So getting rid of APT looks like a good idea but to be consistent with
Wiki/JIRA of Maven I could imagine Confluence to be a better choice.

Regards Mirko
-- 
Sent from my mobile
On Oct 6, 2013 5:31 AM, "Jason van Zyl"  wrote:

> I'm not saying we tell people not to use it, but for us I don't think it's
> an issue. It's been years since anything significant has been added to our
> FAQ and they are few enough that they can be converted by hand to add a
> TOC. I just want to make working with our documentation a little more
> enjoyable and amenable to pull requests.
>
> On Oct 5, 2013, at 5:52 PM, Robert Scholte  wrote:
>
> > https://jira.codehaus.org/browse/DOXIA-472 ? No, still not fixed.
> >
> > IMHO the fml can only be replaced if there's a macro to generate an
> index of all the questions.
> >
> > Robert
> >
> > Op Sat, 05 Oct 2013 22:59:42 +0200 schreef Stephen Connolly <
> stephen.alan.conno...@gmail.com>:
> >
> >> Has the page title problem been fixed?
> >>
> >> Last I checked you could not set the page title that Doxia generates for
> >> HTML pages generated from markdown
> >>
> >> (Crosses fingers that it is fixed)
> >>
> >> On Saturday, 5 October 2013, Jason van Zyl wrote:
> >>
> >>> We current have multiple formats for our site documentation and two of
> >>> them no one else in the world uses except us. We created xdoc here a
> long
> >>> time ago in the Jakarta project, and APT has lost in the world of
> markup. I
> >>> ported it from another project many years ago but there are many better
> >>> options like asciidoc, restructured text, and markdown. My preference
> is
> >>> for markdown but I would like to get rid of xdoc, fml, and xdoc and
> convert
> >>> that documentation over to markdown. The tool support is great for
> editing,
> >>> book support is great (the Pro Git book is created from markdown). We
> can
> >>> still use all the Doxia tools for all the post processing. But I see no
> >>> need to 4 different types of markup for the site, and honestly I find
> >>> working with APT now incredibly annoying.
> >>>
> >>> I'm happy to do the conversion and testing.
> >>>
> >>> Thanks,
> >>>
> >>> Jason
> >>>
> >>> --
> >>> Jason van Zyl
> >>> Founder,  Apache Maven
> >>> http://twitter.com/jvanzyl
> >>> -
> >>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >
> > -
> > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
> > For additional commands, e-mail: dev-h...@maven.apache.org
> >
>
> Thanks,
>
> Jason
>
> --
> Jason van Zyl
> Founder,  Apache Maven
> http://twitter.com/jvanzyl
> -
>
>
>
>
>
>
>
>