You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@click.apache.org by Bob Schellink <sa...@gmail.com> on 2009/02/16 23:50:30 UTC
Click Book
Hi all,
The first draft of the new Click Book is available here [1]. Links to
other Click documentation (such as Javadoc) won't work because the
Javadoc is not included in the zip. Once the new docs is incorporated
into Click proper this won't be an issue.
A big thanks to Gilberto for doing the conversion. Without his help
this would have taken a very long time :)
Still need to check the latest changes in but the svn server is giving
problems atm.
kind regards
bob
[1]: http://people.apache.org/~sabob/test/
Re: Click Book
Posted by Bob Schellink <sa...@gmail.com>.
After a bit of fiddling with docbook and XSLTHL[1], syntax
highlighting is available for PDF as well:
http://people.apache.org/~sabob/test/
regards
bob
[1]: http://sourceforge.net/projects/xslthl
Bob Schellink wrote:
> Hi all,
>
> The first draft of the new Click Book is available here [1]. Links to
> other Click documentation (such as Javadoc) won't work because the
> Javadoc is not included in the zip. Once the new docs is incorporated
> into Click proper this won't be an issue.
>
> A big thanks to Gilberto for doing the conversion. Without his help this
> would have taken a very long time :)
>
> Still need to check the latest changes in but the svn server is giving
> problems atm.
>
> kind regards
>
> bob
>
> [1]: http://people.apache.org/~sabob/test/
>
Re: Click Book
Posted by "Gilberto C. Andrade" <gi...@gmail.com>.
2009/2/16 Bob Schellink <sa...@gmail.com>:
> Hi all,
>
> The first draft of the new Click Book is available here [1]. Links to other
> Click documentation (such as Javadoc) won't work because the Javadoc is not
> included in the zip. Once the new docs is incorporated into Click proper
> this won't be an issue.
>
> A big thanks to Gilberto for doing the conversion. Without his help this
> would have taken a very long time :)
I would like to give the credits to Michael Fuchs, his tool is really util.
(http://www.michael-a-fuchs.de/).
Regards,
Gilberto C. Andrade
Analista de Sistemas/DBA
www.secad.to.gov.br
www.jroller.com/gilbertoca
Re: Click Book
Posted by "Gilberto C. Andrade" <gi...@gmail.com>.
2009/2/20 Bob Schellink <sa...@gmail.com>:
> a_adrian wrote:
>
>> No I can't :(.
>
>
> You're not perhaps in "Reading mode" (ctrl+h)? Only other thing I can think
> of is that the navigation pane is hidden. You should be able to switch it on
> from the "View" menu.
>
> I can confirm however that the bookmarks are there. Perhaps others are also
> having problems with the bookmarks?
>
> bob
>
No, I don't think so! (image)
Gilberto
Re: Click Book
Posted by Bob Schellink <sa...@gmail.com>.
a_adrian wrote:
> No I can't :(.
You're not perhaps in "Reading mode" (ctrl+h)? Only other thing I can
think of is that the navigation pane is hidden. You should be able to
switch it on from the "View" menu.
I can confirm however that the bookmarks are there. Perhaps others are
also having problems with the bookmarks?
bob
Re: Click Book
Posted by a_adrian <a....@googlemail.com>.
sabob wrote:
>
>> In PDF (if configured), there's something called "bookmarks", that can
>> appear as a TOC
>> on the left column.
>
> Oh thats interesting. You're saying you cannot see the bookmarks?
> Because viewing the PDF in Adobe Reader 8.0 the bookmarks are
> displayed on the left hand side. Which viewer are you using?
>
No I can't :(.
I'm using Adobe Reader 8.0 (German edition).
The PDFs that have such bookmarks "active", also have the corresponding icon
on the left for it.
A.
--
View this message in context: http://n2.nabble.com/Click-Book-tp2337825p2360472.html
Sent from the click-development mailing list archive at Nabble.com.
Re: Click Book
Posted by Bob Schellink <sa...@gmail.com>.
> In PDF (if configured), there's something called "bookmarks", that can
> appear as a TOC
> on the left column.
Oh thats interesting. You're saying you cannot see the bookmarks?
Because viewing the PDF in Adobe Reader 8.0 the bookmarks are
displayed on the left hand side. Which viewer are you using?
bob
Re: Click Book
Posted by a_adrian <a....@googlemail.com>.
sabob wrote:
>
>> Very nice PDF, but I think the "book" (PDF version) could be a little bit
>> different than the HTML/Website version, e.g.:
>> - it could contain the cheatsheet as the last page (I suppose this should
>> be
>> a simple inclusion of the actual cheatsheet pdf)
> The cheatsheet is not written in docbook and I'm not sure how one can
> include a raw pdf. Any pointers would be useful.
>
I think there should be some simple "include" directive, to include directly
another PDF at the end.
Of course it depends on the used tools (but I think this is a basic
feature).
sabob wrote:
>
>> - it could have an index at the end (this should be automatically
>> generated)
> I find indexes useful for printed books but not PDFs. The searching
> capabilities work much better for me. That said we can generate an
> index, however I doubts its as simple as a generation switch. How will
> it know what to include in an index? More likely the indexes will have
> to be marked up or written from scratch. Again if there are automated
> ways of doing this I'd like to hear about them.
>
Of course for printed too :). The PDF is the best to print something :).
E.g. sites like http://www.lulu.com/ allow individual publishing.
(of course a nice cover would be needed, but maybe that's not that difficult
:) ).
Regarding index generation, I think it works the same as the Lucene index
generation:
- the tools makes a a simple list of words, with ranking, and at the end,
the user can make a white list out of it, deleting undesired elements. Upon
the next re-indexing, the tool is using only the white list.
If I recall right, even Word can do such a thing (but LaTeX can do it too -
and even more), so I suppose since DocBook is supposed to be the standard
in technical writing, it should have such basic stuff.
sabob wrote:
>
>> - it could have "pdf bookmarks" as the table of content - like seen in
>> many
>> ebooks (this should be also automatically generated).
>
> I don't follow. The pdf already has a TOC which is the same as the pdf
> bookmarks. Do you mean something else?
>
In PDF (if configured), there's something called "bookmarks", that can
appear as a TOC
on the left column.
In Adobe reader I guess it's Ctrl+5.
A tree with the TOC is displayed, allowing quick jumping to the text
(without going to the TOC form the beginning of the book), or if the focus
is on the page, than it can highlight the actual node in the tree.
http://www.novapdf.com/kb_upload/Image/pdf-bookmarks.gif
This makes the work with PDFs very efficient.
Thank you,
A.
--
View this message in context: http://n2.nabble.com/Click-Book-tp2337825p2360242.html
Sent from the click-development mailing list archive at Nabble.com.
Re: Click Book
Posted by Bob Schellink <sa...@gmail.com>.
Hi,
a_adrian wrote:
> Very nice PDF, but I think the "book" (PDF version) could be a little bit
> different than the HTML/Website version, e.g.:
> - it could contain the cheatsheet as the last page (I suppose this should be
> a simple inclusion of the actual cheatsheet pdf)
The cheatsheet is not written in docbook and I'm not sure how one can
include a raw pdf. Any pointers would be useful.
> - it could have an index at the end (this should be automatically generated)
I find indexes useful for printed books but not PDFs. The searching
capabilities work much better for me. That said we can generate an
index, however I doubts its as simple as a generation switch. How will
it know what to include in an index? More likely the indexes will have
to be marked up or written from scratch. Again if there are automated
ways of doing this I'd like to hear about them.
> - it could have "pdf bookmarks" as the table of content - like seen in many
> ebooks (this should be also automatically generated).
I don't follow. The pdf already has a TOC which is the same as the pdf
bookmarks. Do you mean something else?
kind regards
bob
Re: Click Book
Posted by a_adrian <a....@googlemail.com>.
sabob wrote:
>
> The first draft of the new Click Book is available here [1]. Links to
> other Click documentation (such as Javadoc) won't work because the
> Javadoc is not included in the zip. Once the new docs is incorporated
> into Click proper this won't be an issue.
>
> A big thanks to Gilberto for doing the conversion. Without his help
> this would have taken a very long time :)
>
> Still need to check the latest changes in but the svn server is giving
> problems atm.
>
Very nice PDF, but I think the "book" (PDF version) could be a little bit
different than the HTML/Website version, e.g.:
- it could contain the cheatsheet as the last page (I suppose this should be
a simple inclusion of the actual cheatsheet pdf)
- it could have an index at the end (this should be automatically generated)
- it could have "pdf bookmarks" as the table of content - like seen in many
ebooks (this should be also automatically generated).
I think all the above would improve the quality of the book, and are
supposed to be only a few settings at pdf generation.
Thank you,
A.
--
View this message in context: http://n2.nabble.com/Click-Book-tp2337825p2359372.html
Sent from the click-development mailing list archive at Nabble.com.
Re: Click Book
Posted by "florin.g" <fl...@bytenotes.com>.
Thank you!
sabob wrote:
>
>
> Oh yeah, thanks to Malcolm for writing the docs in the first place ;-)
>
>
> Malcolm Edgar wrote:
>> Nice work guys
>>
>> regards Malcolm Edgar
>>
>> On Tue, Feb 17, 2009 at 9:50 AM, Bob Schellink <sabob1@gmail.com
>> <ma...@gmail.com>> wrote:
>>
>> Hi all,
>>
>> The first draft of the new Click Book is available here [1]. Links
>> to other Click documentation (such as Javadoc) won't work because
>> the Javadoc is not included in the zip. Once the new docs is
>> incorporated into Click proper this won't be an issue.
>>
>> A big thanks to Gilberto for doing the conversion. Without his help
>> this would have taken a very long time :)
>>
>> Still need to check the latest changes in but the svn server is
>> giving problems atm.
>>
>> kind regards
>>
>> bob
>>
>> [1]: http://people.apache.org/~sabob/test/
>>
>>
>
>
>
--
View this message in context: http://n2.nabble.com/Click-Book-tp2337825p2339058.html
Sent from the click-development mailing list archive at Nabble.com.
Re: Click Book
Posted by Bob Schellink <sa...@gmail.com>.
Oh yeah, thanks to Malcolm for writing the docs in the first place ;-)
Malcolm Edgar wrote:
> Nice work guys
>
> regards Malcolm Edgar
>
> On Tue, Feb 17, 2009 at 9:50 AM, Bob Schellink <sabob1@gmail.com
> <ma...@gmail.com>> wrote:
>
> Hi all,
>
> The first draft of the new Click Book is available here [1]. Links
> to other Click documentation (such as Javadoc) won't work because
> the Javadoc is not included in the zip. Once the new docs is
> incorporated into Click proper this won't be an issue.
>
> A big thanks to Gilberto for doing the conversion. Without his help
> this would have taken a very long time :)
>
> Still need to check the latest changes in but the svn server is
> giving problems atm.
>
> kind regards
>
> bob
>
> [1]: http://people.apache.org/~sabob/test/
>
>
Re: Click Book
Posted by Malcolm Edgar <ma...@gmail.com>.
Nice work guys
regards Malcolm Edgar
On Tue, Feb 17, 2009 at 9:50 AM, Bob Schellink <sa...@gmail.com> wrote:
> Hi all,
>
> The first draft of the new Click Book is available here [1]. Links to other
> Click documentation (such as Javadoc) won't work because the Javadoc is not
> included in the zip. Once the new docs is incorporated into Click proper
> this won't be an issue.
>
> A big thanks to Gilberto for doing the conversion. Without his help this
> would have taken a very long time :)
>
> Still need to check the latest changes in but the svn server is giving
> problems atm.
>
> kind regards
>
> bob
>
> [1]: http://people.apache.org/~sabob/test/
>