Improving Boost Docs Project, WikiPage

Hi, I have added a new page to boost wiki so we can coordinate our efforts: http://svn.boost.org/trac/boost/wiki/ImprovingBoostDocs * If you want to help us, please jump in. * If you are an author of a lib with html based docs and want to authorize us to help you to translate your docs, please scream it here. * If you are an author of a lib with boostbook based docs and want to authorize us to help you to translate your docs, please state it here. Best regards Matias

[mailto:boost-bounces@lists.boost.org] On Behalf Of Matias Capeletto Subject: [boost] Improving Boost Docs Project, WikiPage
Hi,
I have added a new page to boost wiki so we can coordinate our efforts: http://svn.boost.org/trac/boost/wiki/ImprovingBoostDocs
On the example doc referenced on the wiki -> http://www.drivehq.com/file/df.aspx/publish/matias.capeletto/wwwhome/doc _test/xhtml/index.html Is there any reason for the navigation arrows to be dropping cookies? I blocked the cookies and the navigation seemed to work correctly so if the cookies aren't necessary it would be nice to remove that annoyance. Regards, Matt Scanned by McAfee GroupShield {X3BTB534}

On 6/20/07, Matt Doyle <mdoyle@a-m-c.com> wrote:
[mailto:boost-bounces@lists.boost.org] On Behalf Of Matias Capeletto Subject: [boost] Improving Boost Docs Project, WikiPage
Hi,
I have added a new page to boost wiki so we can coordinate our efforts: http://svn.boost.org/trac/boost/wiki/ImprovingBoostDocs
On the example doc referenced on the wiki -> http://www.drivehq.com/file/df.aspx/publish/matias.capeletto/wwwhome/doc _test/xhtml/index.html
Is there any reason for the navigation arrows to be dropping cookies? I blocked the cookies and the navigation seemed to work correctly so if the cookies aren't necessary it would be nice to remove that annoyance.
A very tiny cookie is used to save your preferred syntax highlighting, it has nothing to do with the GroupedLinks select boxes. I think that browsers will directly support this in the future. Move the mouse to the upper-right corner of a code block and you will see what I am talking about :) Best regards Matias

Hi Matias,
[mailto:boost-bounces@lists.boost.org] On Behalf Of Matias Capeletto Subject: [boost] Improving Boost Docs Project, WikiPage <snip>
Is there any reason for the navigation arrows to be dropping cookies? I blocked the cookies and the navigation seemed to work correctly so if the cookies aren't necessary it would be nice to remove
[mailto:boost-bounces@lists.boost.org] On Behalf Of Matias Capeletto On 6/20/07, Matt Doyle <mdoyle@a-m-c.com> wrote: that annoyance.
A very tiny cookie is used to save your preferred syntax highlighting, it has nothing to do with the GroupedLinks select boxes. I think that browsers will directly support this in the future.
It's not the size of the cookie but that it exists at all. Whenever a website tries to drop a cookie it causes a security dialog to pop-up. Some companies (such as AMC :) have overly paranoid IT managers and they apply policies that either block or warn on such things. It's not a problem, just annoying. :/
Move the mouse to the upper-right corner of a code block and you will see what I am talking about :)
I imagine I was supposed to see some nice options or something but on that page I'm not seeing any mouse-over activity besides clearing the link destination from the navigation bar. Oops, I take that back, the left and right call-out work fine with the mouse over, there's just nothing in any of the corners of the code blocks. Regards, Matt
Best regards Matias _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Scanned by McAfee GroupShield {X3BTB534}

Matt Doyle wrote:
Move the mouse to the upper-right corner of a code block and you will see what I am talking about :)
I imagine I was supposed to see some nice options or something but on that page I'm not seeing any mouse-over activity besides clearing the link destination from the navigation bar. Oops, I take that back, the left and right call-out work fine with the mouse over, there's just nothing in any of the corners of the code blocks.
On firefox 2 for me I have to click on the code block (I guess to give it focus?) then mouse over the top right corner. HTH Michael Marcin

On 6/20/07, Michael Marcin <mmarcin@method-solutions.com> wrote:
Matt Doyle wrote:
Move the mouse to the upper-right corner of a code block and you will see what I am talking about :)
I imagine I was supposed to see some nice options or something but on that page I'm not seeing any mouse-over activity besides clearing the link destination from the navigation bar. Oops, I take that back, the left and right call-out work fine with the mouse over, there's just nothing in any of the corners of the code blocks.
It is not exactly in the very corner, move the mouse around it. I have an idea to improve this. Please have in mind that I have hack this feature between 0am and 6am today. Do not expect it to work as if it where tested by tons of users. Important: ------------------------------------------------------------------------- If you want to help us test this things please post in the boost-docs list. It was not my intention to clutter the boost list with stuff like: "this is not working on netscape" We really need testers. Thanks! ------------------------------------------------------------------------- Regards Matias

Matias Capeletto wrote:
Hi,
I have added a new page to boost wiki so we can coordinate our efforts: http://svn.boost.org/trac/boost/wiki/ImprovingBoostDocs
* If you want to help us, please jump in.
* If you are an author of a lib with html based docs and want to authorize us to help you to translate your docs, please scream it here.
<scream> bind mem_fn smart_ptr </scream>

Matias Capeletto wrote:
Hi,
I have added a new page to boost wiki so we can coordinate our efforts: http://svn.boost.org/trac/boost/wiki/ImprovingBoostDocs
* If you want to help us, please jump in.
* If you are an author of a lib with html based docs and want to authorize us to help you to translate your docs, please scream it here.
* If you are an author of a lib with boostbook based docs and want to authorize us to help you to translate your docs, please state it here.
I have a question regarding libraries in the review queue (especially my Boost.FSM). Is it required for them to have docs in Quickbook now? My library is in html since I had (and still have) problems with setting up Boostbook on which Quickbook relies.

Andrey Semashev wrote:
Matias Capeletto wrote:
Hi,
I have added a new page to boost wiki so we can coordinate our efforts: http://svn.boost.org/trac/boost/wiki/ImprovingBoostDocs
* If you want to help us, please jump in.
* If you are an author of a lib with html based docs and want to authorize us to help you to translate your docs, please scream it here.
* If you are an author of a lib with boostbook based docs and want to authorize us to help you to translate your docs, please state it here.
I have a question regarding libraries in the review queue (especially my Boost.FSM). Is it required for them to have docs in Quickbook now? My library is in html since I had (and still have) problems with setting up Boostbook on which Quickbook relies.
This is the main problem with the tool. We need to get Rene's installer, or something similar, online, to make it easier for people to use quick/boostbook. Installation is the number one PITA. If we make it effortless to install, we'll have more people using it, for sure. Regards, -- Joel de Guzman http://www.boost-consulting.com http://spirit.sf.net

On Thu, 2007-06-21 at 06:33 +0800, Joel de Guzman wrote:
This is the main problem with the tool. We need to get Rene's installer, or something similar, online, to make it easier for people to use quick/boostbook. Installation is the number one PITA. If we make it effortless to install, we'll have more people using it, for sure.
setup_boostbook.sh does a good job on *nix systems, and I presume that setup_boostbook.py does a good job on Windows systems... - Doug

Douglas Gregor wrote:
On Thu, 2007-06-21 at 06:33 +0800, Joel de Guzman wrote:
This is the main problem with the tool. We need to get Rene's installer, or something similar, online, to make it easier for people to use quick/boostbook. Installation is the number one PITA. If we make it effortless to install, we'll have more people using it, for sure.
setup_boostbook.sh does a good job on *nix systems, and I presume that
Yep, no problem on *nix.
setup_boostbook.py does a good job on Windows systems...
Not sure. I didn't even know it exists. It's certainly not in the docs (http://boost.org/doc/html/boostbook/getting/started.html). The docs has tools/boostbook/setup_boostbook.sh (under Automatic setup for Unix-like systems). I did it manually when I started and it was a pain. Also, IMO, a "nearly-automatic setup script" (as doc'd) will not beat a one-shot installer like the one Rene (Rivera) wrote. IIRC it even had quickbook prebuilt so you don't even have to do that step. Regards, -- Joel de Guzman http://www.boost-consulting.com http://spirit.sf.net

Matias Capeletto skrev:
Hi,
* If you are an author of a lib with boostbook based docs and want to authorize us to help you to translate your docs, please state it here.
boost.assign boost.ptr_container boost.range Let me know if anybody starts this effort so we can ensure the right version is translated. cheers -Thorsten

On 6/20/07, Thorsten Ottosen <thorsten.ottosen@dezide.com> wrote:
Matias Capeletto skrev:
Hi,
* If you are an author of a lib with boostbook based docs and want to authorize us to help you to translate your docs, please state it here.
boost.assign boost.ptr_container boost.range
Great! I have them to the queue
Let me know if anybody starts this effort so we can ensure the right version is translated.
Ok Thanks Best regards Matias

Matias Capeletto skrev:
On 6/20/07, Thorsten Ottosen <thorsten.ottosen@dezide.com> wrote:
Matias Capeletto skrev:
Hi, * If you are an author of a lib with boostbook based docs and want to authorize us to help you to translate your docs, please state it here. boost.assign boost.ptr_container boost.range
Great! I have them to the queue
Let me know if anybody starts this effort so we can ensure the right version is translated.
Ok
I don't know if you saw this: http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Google_Summer... Here I advocated writing a tool to simlplify this process ... do you really intend to do the transition manually? -Thorsten

Thorsten Ottosen wrote:
I don't know if you saw this:
http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Google_Summer...
Here I advocated writing a tool to simlplify this process ... do you really intend to do the transition manually?
I suspect that a fully fledged tool isn't worth the hassle, but 20 minutes XSL hacking would probably give you something that would translate paragraphs and tables correctly, which would get you 90% of the way there. Alternatively Rene Rivera had a css style sheet that rendered HTML as quickbook I believe: http://article.gmane.org/gmane.comp.lib.boost.documentation/1632 Again this would probably give enough of a head start to be sufficient for the task? HTH, John.

On 6/21/07, John Maddock <john@johnmaddock.co.uk> wrote:
Thorsten Ottosen wrote:
I don't know if you saw this:
http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Google_Summer...
Here I advocated writing a tool to simlplify this process ... do you really intend to do the transition manually?
I suspect that a fully fledged tool isn't worth the hassle, but 20 minutes XSL hacking would probably give you something that would translate paragraphs and tables correctly, which would get you 90% of the way there.
Yes, that is what I think. Having a tool will be great but it is a lot of work.
Alternatively Rene Rivera had a css style sheet that rendered HTML as quickbook I believe: http://article.gmane.org/gmane.comp.lib.boost.documentation/1632
WOW!!!!!!!!!!!!! My god...... I can not believe it. Thanks Rene! This is amazing, translating docs using this css is very very easy. I can not believe I lost my time in other conversions doing this things manually... With this css translating is a piece of cake. I will tell the translators (there are four active translators!!!) how to use it. I will edit the wiki to show translations best practices. Thanks for pointing this Thanks Rene again! Best regards Matias

Alternatively Rene Rivera had a css style sheet that rendered HTML as quickbook I believe: http://article.gmane.org/gmane.comp.lib.boost.documentation/1632
WOW!!!!!!!!!!!!! My god...... I can not believe it. Thanks Rene! This is amazing, translating docs using this css is very very easy. I can not believe I lost my time in other conversions doing this things manually...
Just to avoid effort duplication I am working on a boosted version of Rene's html to quicbook css in order to add other goodies like link conversion. I will make some docs about: "Converting html to quickbook" that may be worth adding to quickbook docs. Thanks Rene again! Very neat idea you had with this css. Best regards Matias

Would you add a link in the wiki to where quickbook 1.4 is? Is it in the sandbox somewhere? I remember seeing information on it somewhere, but I've lost track of it. You may also want to put this link up: http://www.drivehq.com/file/df.aspx/publish/matias.capeletto/wwwhome/ quickbook/d/d/html/index.html The setup instructions in there are the most useful I've found so far. I assume that work is all related. If not, ignore me. Thanks, Jared

On 6/22/07, Jared McIntyre <jmcintyre@dfsoftware.com> wrote:
Would you add a link in the wiki to where quickbook 1.4 is? Is it in the sandbox somewhere? I remember seeing information on it somewhere, but I've lost track of it.
The last version of Quickbook is in CVS.
You may also want to put this link up:
http://www.drivehq.com/file/df.aspx/publish/matias.capeletto/wwwhome/ quickbook/d/d/html/index.html
The setup instructions in there are the most useful I've found so far.
That is the version at CVS. This page was just a proof of concept of the new stuff, now it seems very old with out the select boxes, the footer, the rounded boxes and other goodies... :) Joel may want to put an online version, I think that it was one somewhere. Best regards Matias

Please add utility/enable_if to the list of libraries whose documentation should be translated to QuickBook. The documentation is currently in hard-written HTML format. It is not too long, and should not be difficult to translate. Thank you, Jeremiah Willcock On Wed, 20 Jun 2007, Matias Capeletto wrote:
Hi,
I have added a new page to boost wiki so we can coordinate our efforts: http://svn.boost.org/trac/boost/wiki/ImprovingBoostDocs
* If you want to help us, please jump in.
* If you are an author of a lib with html based docs and want to authorize us to help you to translate your docs, please scream it here.
* If you are an author of a lib with boostbook based docs and want to authorize us to help you to translate your docs, please state it here.
Best regards Matias _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost

Hi Jeremiah, On 7/19/07, Jeremiah Willcock <jewillco@osl.iu.edu> wrote:
Please add utility/enable_if to the list of libraries whose documentation should be translated to QuickBook. The documentation is currently in hard-written HTML format. It is not too long, and should not be difficult to translate. Thank you,
Thanks for letting us know that it's OK to translate these docs - I have added them to the list of pending docs to be translated on the wiki. Best regards, Stjepan
participants (12)
-
Andrey Semashev
-
Douglas Gregor
-
Jared McIntyre
-
Jeremiah Willcock
-
Joel de Guzman
-
John Maddock
-
Matias Capeletto
-
Matt Doyle
-
Michael Marcin
-
Peter Dimov
-
Stjepan Rajko
-
Thorsten Ottosen