You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@servicemix.apache.org by Gert Vanthienen <ge...@gmail.com> on 2010/11/02 21:38:25 UTC
Re: Documentation project using Scalate
Eric,
Thanks for the design update! I merged your design changes into the
trunk and fixed some minor issues from conflicts with my own changes
over the weekend. Looking forward to the next iteration of the
design...
Regards,
Gert Vanthienen
------------------------
FuseSource
Web: http://fusesource.com
Blog: http://gertvanthienen.blogspot.com/
On Sun, Oct 31, 2010 at 3:05 PM, Eric Johnson <em...@fusesource.com> wrote:
> Gert,
> It definitely ok with me if you merge my changes into the SVN trunk.
> I'll take a stab at moving the site nav out of the blue and putting
> some book nav stuff there instead.
> Cheers,
> Eric
>
> On Sunday, October 31, 2010, Gert Vanthienen <ge...@gmail.com> wrote:
>> Eric,
>>
>> Thanks for contributing to the documentation project! I actually like
>> the idea of breaking out the user's guide into smaller guides that are
>> easier for people to browse and it makes the pages look a lot more
>> 'web-like' (instead of a book dumped on the web). The new challenge
>> would then become to make the guides picker page very explicit about
>> which guide contains which information (e.g. will I find the Camel NMR
>> information in the Camel guide or in the NMR guide).
>>
>> Also, I'm not even sure the sub-guides need the more complex,
>> collapsable TOC on the left hand side any more. We might be able to
>> give our users a more natural, web-like navigation paradigm with
>> cross-links or a smaller TOC in a box on the right hand side (using
>> one of the box colors we have in the website proposal).
>>
>> For the PDF format though, we might want to consider keeping that a
>> single document that contains all the guides. When browsing the
>> internet, it's very convenient to search for contents across a lot of
>> web pages. For a PDF, it's a lot easier to search in a single PDF
>> document though. Also, for people with no prior knowledge whatsoever,
>> getting everything presented to them 'in the right order' is sometimes
>> more convenient. Wdyt?
>>
>> With the improved design, the documentation site also starts looking a
>> lot better. Personally, I would remove the website-specific
>> navigation from the documentation and only provide a link back to the
>> main website from e.g. the top logo. That way, we could reuse that
>> space for menu items to ease navigating the documentation itself.
>>
>> If that's OK for you, I'll merge your commits into the current
>> documentation trunk (and, if we go for a single PDF, take a stab at
>> configuring that as well) later today or on Monday to get SVN
>> documentation trunk back in sync with the work you've been doing.
>>
>> Regards,
>>
>> Gert Vanthienen
>> ------------------------
>> Web: http://fusesource.com
>> Blog: http://gertvanthienen.blogspot.com/
>>
>>
>>
>> On Sat, Oct 30, 2010 at 12:35 AM, Eric Johnson <em...@fusesource.com> wrote:
>>> I just made a bunch of updates to my fork[1] of the documentation project to
>>> do the following:
>>> * make the site nav stuff match the look and feel of the proposed scalate
>>> Web site
>>> * added a contributing page that needs a little more content
>>> * added a page for listing "pay" documentation
>>> * broke the user-guide into four smaller guides
>>> * made the toc function able to work at any depth
>>>
>>> The idea for breaking out big books (like the user guide) into smaller ones
>>> is to make it less daunting for users. People don't like wading through huge
>>> TOCs looking for things IMHO.
>>>
>>> I propose making a GUIDES entry on the site navigation that links to all of
>>> the "books" in the set.
>>>
>>> [1] git://github.com/emjohnson/servicemix-documentation.git
>>>
>>> On Thu, Oct 28, 2010 at 7:58 AM, Gert Vanthienen
>>> <ge...@gmail.com>wrote:
>>>
>>>> L.S.,
>>>>
>>>> Thanks James -- I just upgraded both the website and the documentation
>>>> project to Scalate 1.3.1
>>>>
>>>> Regards,
>>>>
>>>> Gert Vanthienen
>>>> ------------------------
>>>> Web: http://fusesource.com
>>>> Blog: http://gertvanthienen.blogspot.com/
>>>>
>>>>
>>>>
>>>> On Thu, Oct 28, 2010 at 10:01 AM, James Strachan
>>>> <ja...@gmail.com> wrote:
>>>> > On 27 October 2010 15:11, James Strachan <ja...@gmail.com>
>>>> wrote:
>>>> >> On 20 October 2010 03:38, Chris Custine <ch...@gmail.com>
>>>> wrote:
>>>> >>> FWIW, I think if we like the SyntaxHighlighter for web pages (I know I
>>>> >>> prefer it), it looks like we can subclass HtmlFormatter in Pygmentize
>>>> write
>>>> >>> out the <pre> wrappers for SyntaxHighlighter. Based on what James
>>>> says, we
>>>> >>> could also do that as a filter but I'm not sure which is the best
>>>> place.
>>>> >>>
>>>> >>> Anyway, just a thought to put out there.
>>>> >>
>>>> >> Thanks to a patch from Łukasz Dywicki which I then modified slightly
>>>> >> to use the expected SyntaxHighlighter syntax, the {pygmentize} tag
>>>> >> will run if you have not got pygmentize installed and will use the
>>>> >> output which can be styled by including the SyntaxHighlighter JS.
>>>> >>
>>>> >> This code is in 1.4-SNAPSHOT of scalate now; I'll be cutting 1.3.1
>>>> soon...
>>>> >
>>>> > 1.3.1 is out now with this feature if you want to switch - it also
>>>> > includes Gert's changes so the web app works in OSGi...
>>>> >
>>>> > --
>>>> > James
>>>> > -------
>>>> > FuseSource
>>>> > Email: james@fusesource.com
>>>> > Web: http://fusesource.com
>>>> > Twitter: jstrachan
>>>> > Blog: http://macstrac.blogspot.com/
>>>> >
>>>> > Open Source Integration
>>>> >
>>>>
>>>
>>>
>>>
>>> --
>>> Principle Technical Writer
>>>
>>> Phone (781) 280-4174
>>> Skype finnmccumial
>>> E-Mail emjohnson@fusesource.com
>>> Blog http://documentingit.blogspot.com/
>>>
>>
>
> --
> Principle Technical Writer
>
> Phone (781) 280-4174
> Skype finnmccumial
> E-Mail emjohnson@fusesource.com
> Blog http://documentingit.blogspot.com/
>
Re: Documentation project using Scalate
Posted by Lars Heinemann <lh...@apache.org>.
Or maybe we can aggregate those smaller PDFs at the end to one big document.
Best regards,
Lars
--------------------------------------
Lars Heinemann
FuseSource
Email: lhein@fusesource.com
Web: http://www.fusesource.com
Blog: http://lhein.blogspot.com
Twitter: lhein77
Am 05.11.2010 um 11:11 schrieb Jean-Baptiste Onofré:
> For my point of view, regarding pdf, it's better to have a pdf document gathering all sections.
> It's better to split for html rendering, but I don't think so for pdf.
>
> Regards
> JB
> -----Original Message-----
> From: Gert Vanthienen <ge...@gmail.com>
> Date: Fri, 5 Nov 2010 11:06:47
> To: <de...@servicemix.apache.org>
> Reply-To: dev@servicemix.apache.org
> Subject: Re: Documentation project using Scalate
>
> L.S.,
>
> For the user's guide, I have now picked up Eric's changes to have
> several, smaller subguides. I think it looks great for the HTML
> pages. How about the PDF equivalent? Do we also prefer multiple
> smaller PDF documents for the subguides or rather have a single PDF
> for the user's guide? I can see the benefits of both approaches, so
> I'm looking for what other people think before I fix up the project
> either way.
>
> Regards,
>
> Gert Vanthienen
> ------------------------
> FuseSource
> Web: http://fusesource.com
> Blog: http://gertvanthienen.blogspot.com/
>
>
>
> On Tue, Nov 2, 2010 at 9:38 PM, Gert Vanthienen
> <ge...@gmail.com> wrote:
>> Eric,
>>
>> Thanks for the design update! I merged your design changes into the
>> trunk and fixed some minor issues from conflicts with my own changes
>> over the weekend. Looking forward to the next iteration of the
>> design...
>>
>> Regards,
>>
>> Gert Vanthienen
>> ------------------------
>> FuseSource
>> Web: http://fusesource.com
>> Blog: http://gertvanthienen.blogspot.com/
>>
>>
>>
>> On Sun, Oct 31, 2010 at 3:05 PM, Eric Johnson <em...@fusesource.com> wrote:
>>> Gert,
>>> It definitely ok with me if you merge my changes into the SVN trunk.
>>> I'll take a stab at moving the site nav out of the blue and putting
>>> some book nav stuff there instead.
>>> Cheers,
>>> Eric
>>>
>>> On Sunday, October 31, 2010, Gert Vanthienen <ge...@gmail.com> wrote:
>>>> Eric,
>>>>
>>>> Thanks for contributing to the documentation project! I actually like
>>>> the idea of breaking out the user's guide into smaller guides that are
>>>> easier for people to browse and it makes the pages look a lot more
>>>> 'web-like' (instead of a book dumped on the web). The new challenge
>>>> would then become to make the guides picker page very explicit about
>>>> which guide contains which information (e.g. will I find the Camel NMR
>>>> information in the Camel guide or in the NMR guide).
>>>>
>>>> Also, I'm not even sure the sub-guides need the more complex,
>>>> collapsable TOC on the left hand side any more. We might be able to
>>>> give our users a more natural, web-like navigation paradigm with
>>>> cross-links or a smaller TOC in a box on the right hand side (using
>>>> one of the box colors we have in the website proposal).
>>>>
>>>> For the PDF format though, we might want to consider keeping that a
>>>> single document that contains all the guides. When browsing the
>>>> internet, it's very convenient to search for contents across a lot of
>>>> web pages. For a PDF, it's a lot easier to search in a single PDF
>>>> document though. Also, for people with no prior knowledge whatsoever,
>>>> getting everything presented to them 'in the right order' is sometimes
>>>> more convenient. Wdyt?
>>>>
>>>> With the improved design, the documentation site also starts looking a
>>>> lot better. Personally, I would remove the website-specific
>>>> navigation from the documentation and only provide a link back to the
>>>> main website from e.g. the top logo. That way, we could reuse that
>>>> space for menu items to ease navigating the documentation itself.
>>>>
>>>> If that's OK for you, I'll merge your commits into the current
>>>> documentation trunk (and, if we go for a single PDF, take a stab at
>>>> configuring that as well) later today or on Monday to get SVN
>>>> documentation trunk back in sync with the work you've been doing.
>>>>
>>>> Regards,
>>>>
>>>> Gert Vanthienen
>>>> ------------------------
>>>> Web: http://fusesource.com
>>>> Blog: http://gertvanthienen.blogspot.com/
>>>>
>>>>
>>>>
>>>> On Sat, Oct 30, 2010 at 12:35 AM, Eric Johnson <em...@fusesource.com> wrote:
>>>>> I just made a bunch of updates to my fork[1] of the documentation project to
>>>>> do the following:
>>>>> * make the site nav stuff match the look and feel of the proposed scalate
>>>>> Web site
>>>>> * added a contributing page that needs a little more content
>>>>> * added a page for listing "pay" documentation
>>>>> * broke the user-guide into four smaller guides
>>>>> * made the toc function able to work at any depth
>>>>>
>>>>> The idea for breaking out big books (like the user guide) into smaller ones
>>>>> is to make it less daunting for users. People don't like wading through huge
>>>>> TOCs looking for things IMHO.
>>>>>
>>>>> I propose making a GUIDES entry on the site navigation that links to all of
>>>>> the "books" in the set.
>>>>>
>>>>> [1] git://github.com/emjohnson/servicemix-documentation.git
>>>>>
>>>>> On Thu, Oct 28, 2010 at 7:58 AM, Gert Vanthienen
>>>>> <ge...@gmail.com>wrote:
>>>>>
>>>>>> L.S.,
>>>>>>
>>>>>> Thanks James -- I just upgraded both the website and the documentation
>>>>>> project to Scalate 1.3.1
>>>>>>
>>>>>> Regards,
>>>>>>
>>>>>> Gert Vanthienen
>>>>>> ------------------------
>>>>>> Web: http://fusesource.com
>>>>>> Blog: http://gertvanthienen.blogspot.com/
>>>>>>
>>>>>>
>>>>>>
>>>>>> On Thu, Oct 28, 2010 at 10:01 AM, James Strachan
>>>>>> <ja...@gmail.com> wrote:
>>>>>>> On 27 October 2010 15:11, James Strachan <ja...@gmail.com>
>>>>>> wrote:
>>>>>>>> On 20 October 2010 03:38, Chris Custine <ch...@gmail.com>
>>>>>> wrote:
>>>>>>>>> FWIW, I think if we like the SyntaxHighlighter for web pages (I know I
>>>>>>>>> prefer it), it looks like we can subclass HtmlFormatter in Pygmentize
>>>>>> write
>>>>>>>>> out the <pre> wrappers for SyntaxHighlighter. Based on what James
>>>>>> says, we
>>>>>>>>> could also do that as a filter but I'm not sure which is the best
>>>>>> place.
>>>>>>>>>
>>>>>>>>> Anyway, just a thought to put out there.
>>>>>>>>
>>>>>>>> Thanks to a patch from Łukasz Dywicki which I then modified slightly
>>>>>>>> to use the expected SyntaxHighlighter syntax, the {pygmentize} tag
>>>>>>>> will run if you have not got pygmentize installed and will use the
>>>>>>>> output which can be styled by including the SyntaxHighlighter JS.
>>>>>>>>
>>>>>>>> This code is in 1.4-SNAPSHOT of scalate now; I'll be cutting 1.3.1
>>>>>> soon...
>>>>>>>
>>>>>>> 1.3.1 is out now with this feature if you want to switch - it also
>>>>>>> includes Gert's changes so the web app works in OSGi...
>>>>>>>
>>>>>>> --
>>>>>>> James
>>>>>>> -------
>>>>>>> FuseSource
>>>>>>> Email: james@fusesource.com
>>>>>>> Web: http://fusesource.com
>>>>>>> Twitter: jstrachan
>>>>>>> Blog: http://macstrac.blogspot.com/
>>>>>>>
>>>>>>> Open Source Integration
>>>>>>>
>>>>>>
>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> Principle Technical Writer
>>>>>
>>>>> Phone (781) 280-4174
>>>>> Skype finnmccumial
>>>>> E-Mail emjohnson@fusesource.com
>>>>> Blog http://documentingit.blogspot.com/
>>>>>
>>>>
>>>
>>> --
>>> Principle Technical Writer
>>>
>>> Phone (781) 280-4174
>>> Skype finnmccumial
>>> E-Mail emjohnson@fusesource.com
>>> Blog http://documentingit.blogspot.com/
>>>
>>
Re: Documentation project using Scalate
Posted by Jean-Baptiste Onofré <jb...@nanthrax.net>.
For my point of view, regarding pdf, it's better to have a pdf document gathering all sections.
It's better to split for html rendering, but I don't think so for pdf.
Regards
JB
-----Original Message-----
From: Gert Vanthienen <ge...@gmail.com>
Date: Fri, 5 Nov 2010 11:06:47
To: <de...@servicemix.apache.org>
Reply-To: dev@servicemix.apache.org
Subject: Re: Documentation project using Scalate
L.S.,
For the user's guide, I have now picked up Eric's changes to have
several, smaller subguides. I think it looks great for the HTML
pages. How about the PDF equivalent? Do we also prefer multiple
smaller PDF documents for the subguides or rather have a single PDF
for the user's guide? I can see the benefits of both approaches, so
I'm looking for what other people think before I fix up the project
either way.
Regards,
Gert Vanthienen
------------------------
FuseSource
Web: http://fusesource.com
Blog: http://gertvanthienen.blogspot.com/
On Tue, Nov 2, 2010 at 9:38 PM, Gert Vanthienen
<ge...@gmail.com> wrote:
> Eric,
>
> Thanks for the design update! I merged your design changes into the
> trunk and fixed some minor issues from conflicts with my own changes
> over the weekend. Looking forward to the next iteration of the
> design...
>
> Regards,
>
> Gert Vanthienen
> ------------------------
> FuseSource
> Web: http://fusesource.com
> Blog: http://gertvanthienen.blogspot.com/
>
>
>
> On Sun, Oct 31, 2010 at 3:05 PM, Eric Johnson <em...@fusesource.com> wrote:
>> Gert,
>> It definitely ok with me if you merge my changes into the SVN trunk.
>> I'll take a stab at moving the site nav out of the blue and putting
>> some book nav stuff there instead.
>> Cheers,
>> Eric
>>
>> On Sunday, October 31, 2010, Gert Vanthienen <ge...@gmail.com> wrote:
>>> Eric,
>>>
>>> Thanks for contributing to the documentation project! I actually like
>>> the idea of breaking out the user's guide into smaller guides that are
>>> easier for people to browse and it makes the pages look a lot more
>>> 'web-like' (instead of a book dumped on the web). The new challenge
>>> would then become to make the guides picker page very explicit about
>>> which guide contains which information (e.g. will I find the Camel NMR
>>> information in the Camel guide or in the NMR guide).
>>>
>>> Also, I'm not even sure the sub-guides need the more complex,
>>> collapsable TOC on the left hand side any more. We might be able to
>>> give our users a more natural, web-like navigation paradigm with
>>> cross-links or a smaller TOC in a box on the right hand side (using
>>> one of the box colors we have in the website proposal).
>>>
>>> For the PDF format though, we might want to consider keeping that a
>>> single document that contains all the guides. When browsing the
>>> internet, it's very convenient to search for contents across a lot of
>>> web pages. For a PDF, it's a lot easier to search in a single PDF
>>> document though. Also, for people with no prior knowledge whatsoever,
>>> getting everything presented to them 'in the right order' is sometimes
>>> more convenient. Wdyt?
>>>
>>> With the improved design, the documentation site also starts looking a
>>> lot better. Personally, I would remove the website-specific
>>> navigation from the documentation and only provide a link back to the
>>> main website from e.g. the top logo. That way, we could reuse that
>>> space for menu items to ease navigating the documentation itself.
>>>
>>> If that's OK for you, I'll merge your commits into the current
>>> documentation trunk (and, if we go for a single PDF, take a stab at
>>> configuring that as well) later today or on Monday to get SVN
>>> documentation trunk back in sync with the work you've been doing.
>>>
>>> Regards,
>>>
>>> Gert Vanthienen
>>> ------------------------
>>> Web: http://fusesource.com
>>> Blog: http://gertvanthienen.blogspot.com/
>>>
>>>
>>>
>>> On Sat, Oct 30, 2010 at 12:35 AM, Eric Johnson <em...@fusesource.com> wrote:
>>>> I just made a bunch of updates to my fork[1] of the documentation project to
>>>> do the following:
>>>> * make the site nav stuff match the look and feel of the proposed scalate
>>>> Web site
>>>> * added a contributing page that needs a little more content
>>>> * added a page for listing "pay" documentation
>>>> * broke the user-guide into four smaller guides
>>>> * made the toc function able to work at any depth
>>>>
>>>> The idea for breaking out big books (like the user guide) into smaller ones
>>>> is to make it less daunting for users. People don't like wading through huge
>>>> TOCs looking for things IMHO.
>>>>
>>>> I propose making a GUIDES entry on the site navigation that links to all of
>>>> the "books" in the set.
>>>>
>>>> [1] git://github.com/emjohnson/servicemix-documentation.git
>>>>
>>>> On Thu, Oct 28, 2010 at 7:58 AM, Gert Vanthienen
>>>> <ge...@gmail.com>wrote:
>>>>
>>>>> L.S.,
>>>>>
>>>>> Thanks James -- I just upgraded both the website and the documentation
>>>>> project to Scalate 1.3.1
>>>>>
>>>>> Regards,
>>>>>
>>>>> Gert Vanthienen
>>>>> ------------------------
>>>>> Web: http://fusesource.com
>>>>> Blog: http://gertvanthienen.blogspot.com/
>>>>>
>>>>>
>>>>>
>>>>> On Thu, Oct 28, 2010 at 10:01 AM, James Strachan
>>>>> <ja...@gmail.com> wrote:
>>>>> > On 27 October 2010 15:11, James Strachan <ja...@gmail.com>
>>>>> wrote:
>>>>> >> On 20 October 2010 03:38, Chris Custine <ch...@gmail.com>
>>>>> wrote:
>>>>> >>> FWIW, I think if we like the SyntaxHighlighter for web pages (I know I
>>>>> >>> prefer it), it looks like we can subclass HtmlFormatter in Pygmentize
>>>>> write
>>>>> >>> out the <pre> wrappers for SyntaxHighlighter. Based on what James
>>>>> says, we
>>>>> >>> could also do that as a filter but I'm not sure which is the best
>>>>> place.
>>>>> >>>
>>>>> >>> Anyway, just a thought to put out there.
>>>>> >>
>>>>> >> Thanks to a patch from Łukasz Dywicki which I then modified slightly
>>>>> >> to use the expected SyntaxHighlighter syntax, the {pygmentize} tag
>>>>> >> will run if you have not got pygmentize installed and will use the
>>>>> >> output which can be styled by including the SyntaxHighlighter JS.
>>>>> >>
>>>>> >> This code is in 1.4-SNAPSHOT of scalate now; I'll be cutting 1.3.1
>>>>> soon...
>>>>> >
>>>>> > 1.3.1 is out now with this feature if you want to switch - it also
>>>>> > includes Gert's changes so the web app works in OSGi...
>>>>> >
>>>>> > --
>>>>> > James
>>>>> > -------
>>>>> > FuseSource
>>>>> > Email: james@fusesource.com
>>>>> > Web: http://fusesource.com
>>>>> > Twitter: jstrachan
>>>>> > Blog: http://macstrac.blogspot.com/
>>>>> >
>>>>> > Open Source Integration
>>>>> >
>>>>>
>>>>
>>>>
>>>>
>>>> --
>>>> Principle Technical Writer
>>>>
>>>> Phone (781) 280-4174
>>>> Skype finnmccumial
>>>> E-Mail emjohnson@fusesource.com
>>>> Blog http://documentingit.blogspot.com/
>>>>
>>>
>>
>> --
>> Principle Technical Writer
>>
>> Phone (781) 280-4174
>> Skype finnmccumial
>> E-Mail emjohnson@fusesource.com
>> Blog http://documentingit.blogspot.com/
>>
>
Re: Documentation project using Scalate
Posted by Gert Vanthienen <ge...@gmail.com>.
L.S.,
For the user's guide, I have now picked up Eric's changes to have
several, smaller subguides. I think it looks great for the HTML
pages. How about the PDF equivalent? Do we also prefer multiple
smaller PDF documents for the subguides or rather have a single PDF
for the user's guide? I can see the benefits of both approaches, so
I'm looking for what other people think before I fix up the project
either way.
Regards,
Gert Vanthienen
------------------------
FuseSource
Web: http://fusesource.com
Blog: http://gertvanthienen.blogspot.com/
On Tue, Nov 2, 2010 at 9:38 PM, Gert Vanthienen
<ge...@gmail.com> wrote:
> Eric,
>
> Thanks for the design update! I merged your design changes into the
> trunk and fixed some minor issues from conflicts with my own changes
> over the weekend. Looking forward to the next iteration of the
> design...
>
> Regards,
>
> Gert Vanthienen
> ------------------------
> FuseSource
> Web: http://fusesource.com
> Blog: http://gertvanthienen.blogspot.com/
>
>
>
> On Sun, Oct 31, 2010 at 3:05 PM, Eric Johnson <em...@fusesource.com> wrote:
>> Gert,
>> It definitely ok with me if you merge my changes into the SVN trunk.
>> I'll take a stab at moving the site nav out of the blue and putting
>> some book nav stuff there instead.
>> Cheers,
>> Eric
>>
>> On Sunday, October 31, 2010, Gert Vanthienen <ge...@gmail.com> wrote:
>>> Eric,
>>>
>>> Thanks for contributing to the documentation project! I actually like
>>> the idea of breaking out the user's guide into smaller guides that are
>>> easier for people to browse and it makes the pages look a lot more
>>> 'web-like' (instead of a book dumped on the web). The new challenge
>>> would then become to make the guides picker page very explicit about
>>> which guide contains which information (e.g. will I find the Camel NMR
>>> information in the Camel guide or in the NMR guide).
>>>
>>> Also, I'm not even sure the sub-guides need the more complex,
>>> collapsable TOC on the left hand side any more. We might be able to
>>> give our users a more natural, web-like navigation paradigm with
>>> cross-links or a smaller TOC in a box on the right hand side (using
>>> one of the box colors we have in the website proposal).
>>>
>>> For the PDF format though, we might want to consider keeping that a
>>> single document that contains all the guides. When browsing the
>>> internet, it's very convenient to search for contents across a lot of
>>> web pages. For a PDF, it's a lot easier to search in a single PDF
>>> document though. Also, for people with no prior knowledge whatsoever,
>>> getting everything presented to them 'in the right order' is sometimes
>>> more convenient. Wdyt?
>>>
>>> With the improved design, the documentation site also starts looking a
>>> lot better. Personally, I would remove the website-specific
>>> navigation from the documentation and only provide a link back to the
>>> main website from e.g. the top logo. That way, we could reuse that
>>> space for menu items to ease navigating the documentation itself.
>>>
>>> If that's OK for you, I'll merge your commits into the current
>>> documentation trunk (and, if we go for a single PDF, take a stab at
>>> configuring that as well) later today or on Monday to get SVN
>>> documentation trunk back in sync with the work you've been doing.
>>>
>>> Regards,
>>>
>>> Gert Vanthienen
>>> ------------------------
>>> Web: http://fusesource.com
>>> Blog: http://gertvanthienen.blogspot.com/
>>>
>>>
>>>
>>> On Sat, Oct 30, 2010 at 12:35 AM, Eric Johnson <em...@fusesource.com> wrote:
>>>> I just made a bunch of updates to my fork[1] of the documentation project to
>>>> do the following:
>>>> * make the site nav stuff match the look and feel of the proposed scalate
>>>> Web site
>>>> * added a contributing page that needs a little more content
>>>> * added a page for listing "pay" documentation
>>>> * broke the user-guide into four smaller guides
>>>> * made the toc function able to work at any depth
>>>>
>>>> The idea for breaking out big books (like the user guide) into smaller ones
>>>> is to make it less daunting for users. People don't like wading through huge
>>>> TOCs looking for things IMHO.
>>>>
>>>> I propose making a GUIDES entry on the site navigation that links to all of
>>>> the "books" in the set.
>>>>
>>>> [1] git://github.com/emjohnson/servicemix-documentation.git
>>>>
>>>> On Thu, Oct 28, 2010 at 7:58 AM, Gert Vanthienen
>>>> <ge...@gmail.com>wrote:
>>>>
>>>>> L.S.,
>>>>>
>>>>> Thanks James -- I just upgraded both the website and the documentation
>>>>> project to Scalate 1.3.1
>>>>>
>>>>> Regards,
>>>>>
>>>>> Gert Vanthienen
>>>>> ------------------------
>>>>> Web: http://fusesource.com
>>>>> Blog: http://gertvanthienen.blogspot.com/
>>>>>
>>>>>
>>>>>
>>>>> On Thu, Oct 28, 2010 at 10:01 AM, James Strachan
>>>>> <ja...@gmail.com> wrote:
>>>>> > On 27 October 2010 15:11, James Strachan <ja...@gmail.com>
>>>>> wrote:
>>>>> >> On 20 October 2010 03:38, Chris Custine <ch...@gmail.com>
>>>>> wrote:
>>>>> >>> FWIW, I think if we like the SyntaxHighlighter for web pages (I know I
>>>>> >>> prefer it), it looks like we can subclass HtmlFormatter in Pygmentize
>>>>> write
>>>>> >>> out the <pre> wrappers for SyntaxHighlighter. Based on what James
>>>>> says, we
>>>>> >>> could also do that as a filter but I'm not sure which is the best
>>>>> place.
>>>>> >>>
>>>>> >>> Anyway, just a thought to put out there.
>>>>> >>
>>>>> >> Thanks to a patch from Łukasz Dywicki which I then modified slightly
>>>>> >> to use the expected SyntaxHighlighter syntax, the {pygmentize} tag
>>>>> >> will run if you have not got pygmentize installed and will use the
>>>>> >> output which can be styled by including the SyntaxHighlighter JS.
>>>>> >>
>>>>> >> This code is in 1.4-SNAPSHOT of scalate now; I'll be cutting 1.3.1
>>>>> soon...
>>>>> >
>>>>> > 1.3.1 is out now with this feature if you want to switch - it also
>>>>> > includes Gert's changes so the web app works in OSGi...
>>>>> >
>>>>> > --
>>>>> > James
>>>>> > -------
>>>>> > FuseSource
>>>>> > Email: james@fusesource.com
>>>>> > Web: http://fusesource.com
>>>>> > Twitter: jstrachan
>>>>> > Blog: http://macstrac.blogspot.com/
>>>>> >
>>>>> > Open Source Integration
>>>>> >
>>>>>
>>>>
>>>>
>>>>
>>>> --
>>>> Principle Technical Writer
>>>>
>>>> Phone (781) 280-4174
>>>> Skype finnmccumial
>>>> E-Mail emjohnson@fusesource.com
>>>> Blog http://documentingit.blogspot.com/
>>>>
>>>
>>
>> --
>> Principle Technical Writer
>>
>> Phone (781) 280-4174
>> Skype finnmccumial
>> E-Mail emjohnson@fusesource.com
>> Blog http://documentingit.blogspot.com/
>>
>