Re: Site documentation format choosing

2009-07-29 Thread nsowatsk
We use APT as it is easy to use and has features like snippets that allow us to include code in the documents. Of course you can also use html in the resources directory also, so using APT doesn't mean that's all you get. APT also allows you to create .apt.vm files that can contain macros that

Re: Site documentation format choosing

2009-07-29 Thread Lukas Theussl
Just use the easiest tool that does the job, it all depends on what you need. Apt is easy to learn and use (especially for people who are allergic to xml), but in turn it also lacks in flexibility and misses advanced functionality, eg (from the top of my head): - no styles (css) - no

Re: Site documentation format choosing

2009-07-29 Thread Stefan Seidel
On Wed, 29 Jul 2009 10:44:28 +0200 Lukas Theussl ltheu...@apache.org wrote: turn it also lacks in flexibility and misses advanced functionality, eg (from the top of my head): - no advanced formatting and layout (eg tables) Wrong, tables are easily possible. - no meta-information What do

Re: Site documentation format choosing

2009-07-29 Thread nsowatsk
Hi APT does support style sheets for Maven sites. We have our own LF for our APT based sites. I have many images included in my APT files using URLs. Table layout is no better or worse than a Wiki. Meta information can be supported by Velocity templates *.apt.vm). Regards Nathan On

Re: Site documentation format choosing

2009-07-29 Thread Lukas Theussl
Stefan Seidel wrote: On Wed, 29 Jul 2009 10:44:28 +0200 Lukas Theussl ltheu...@apache.org wrote: turn it also lacks in flexibility and misses advanced functionality, eg (from the top of my head): - no advanced formatting and layout (eg tables) Wrong, tables are easily possible. Of

Re: Site documentation format choosing

2009-07-29 Thread nsowatsk
Hi The list of meta data that you give below is partly addressed in different sections of the pom. Once they are in the pom, they also get processed by the standard Maven report plugin and so appear in various web pages created by that plugin. Also, by using velocity (.apt.vm) you can include

Re: Site documentation format choosing

2009-07-29 Thread Lukas Theussl
nsowatsk wrote: Hi APT does support style sheets for Maven sites. We have our own LF for our APT based sites. So how do you write that in apt: p style=color:red; font-size:8px;A small red paragraph/p p style=color:blue; font-size:20px;A large blue paragraph/p ? I have many images

Re: Site documentation format choosing

2009-07-29 Thread Lukas Theussl
I was only listing the differences/limitations of the document format itself. Whatever tools you use around it (maven, velocity) can be applied to any other document format as well. -Lukas nsowatsk wrote: Hi The list of meta data that you give below is partly addressed in different

Re: Site documentation format choosing

2009-07-29 Thread Rodrigo Ruiz
I agree with you Lukas, The APT format simpler than the rest, and this has good and bad points. Modifications at template level are applied to the whole site, and are independent from the document format, so they are not really relevant if the point is just to decide which document format to

Re: Site documentation format choosing

2009-07-29 Thread nsowatsk
Hi I live without multi-coloured paragraphs, but the overall skin I can do a lot with :-) Images are included like this: [http://url/image.gif] The title is best created as a link {Image Name} before the '[]'s Regards Nathan On 29/07/2009 12:07, Lukas Theussl ltheu...@apache.org wrote:

Re: Site documentation format choosing

2009-07-29 Thread Lukas Theussl
nsowatsk wrote: Hi I live without multi-coloured paragraphs, but the overall skin I can do a lot with :-) Images are included like this: [http://url/image.gif] The title is best created as a link {Image Name} before the '[]'s That's not what I meant, I meant the image itself is the link,

RE: Site documentation format choosing

2009-07-29 Thread EJ Ciramella
Thanks everyone for the debate for me to watch - I just kinda sat back and ate popcorn while you guys battled it out. Here are what I've captured: 1 - people like apt for its simplicity (me too) - I can see how easy it would be to diff various versions in your SCM tool. You'd not see tags, just

Re: Site documentation format choosing

2009-07-29 Thread Kalle Korhonen
One more - APT was great for our purposes since we wanted a plain text release note in email as well as a html version - with APT we need to update just a single source file. Kalle On Wed, Jul 29, 2009 at 8:15 AM, EJ Ciramellaecirame...@upromise.com wrote: Thanks everyone for the debate for me

Site documentation format choosing

2009-07-28 Thread EJ Ciramella
So a discussion has popped up here as to why use apt, xdoc or fml over just plain html. I (personally) think it's easier to just throw together APT docs REALLY fast and not worry about various components (css and such). How do I sell apt as the format to use?