function.xml vs boostbook.dtd

Hi,

It seems that the attribute xmlns:xi="http://www.w3.org/2001/XInclude"
on the "library" element is not supported by boostbook.dtd.

All the files that use <xi:include href="..."> generate errors when
processed with xsltproc ("Using libxml 20632, libxslt 10123 and
libexslt 813").

The MSXML parser signals the same error (function.xml, line 6).

I would like to ask someone who is more experienced with BoostBook to
take 5 minutes of his/her time and test the instructions posted here
http://www.boost.org/doc/libs/1_35_0/doc/html/boostbook/getting/started.html
on Windows (only up to building function.xml, even without downloading
local copies of the DTD/XSD files.

They don't seem to work... unless skipping validation against the
boostbook.dtd file (e.g. by erasing the file).

Thank you,

--

-- 
Best regards,
 Adder

BoostBook namespace problem vs Getting Started Instructions

Hi,

While following the instructions here:
http://www.boost.org/doc/libs/1_35_0/doc/html/boostbook/getting/started.html
I have encountered some problems in building the doc for "function"
(on Windows, with no Cygwin).

With the xsltproc distribution from
http://www.meta-comm.com/engineering/boost/xsltproc-win32.zip
I am getting many warnings, a "runtime error" and no html files.

With the xsltproc distribution from
http://www.zlatkovic.com/libxml.en.html
I am getting:

    function.xml:6: namespace error : Namespace prefix xmlns for xi on library is not defined
      xmlns:xi="http://www.w3.org/2001/XInclude">

    function.xml:54: namespace error : Namespace prefix xi on include is not defined
      <xi:include href="history.xml"/>

    ...

    Writing index.html for chapter(function)
    Writing function-doc_HTML.manifest

I have tried both downloading the XSL/DTD files to my computer and
downloading them "on-the-fly", with the same results.

I would like to kindly ask you:

external link in boostbook documentation is broken

In the "Documenting Libraries" section, "Converting HTML to Boostbook" 
table, the external link for the tutorial for tables no longer works.

--

-- 
Jon Biggar
Floorboard Software
jon <at> floorboard.com
jon <at> biggar.org

Re: Three-part tutorial on using Boost

Ruediger Berlich wrote:
> Hi Rene,
> thanks a lot!
> 
> BTW, would it make sense to order to the bibliography entries in reverse 
> chronological order ? I.e., rather than putting the oldest news on top, I 
> believe that having the newest entries there would make the page even more 
> accessible.

Yes, good point.

--

-- 
-- Grafik - Don't Assume Anything
-- Redshift Software, Inc. - http://redshift-software.com
-- rrivera/acm.org (msn) - grafik/redshift-software.com
-- 102708583/icq - grafikrobot/aim,yahoo,skype,efnet,gmail

Including a few lines from another file in BoostBook?

I've been converting a Quickbook documentation to DocBook. In some  
Quickbook files I've seen some references to source files where only a  
part of the source file seems to be included - something like this:

[include ../example/tutorial.cpp c++ include-headers]

This sounds like a good idea as the source file is complete (and can be  
automatically built and tested) but only the few lines are included which  
are relevant. I wonder though if this can be done with DocBook, too (or  
BoostBook)?

Boris

Three-part tutorial on using Boost

Hi there,

I'm not really sure where else to post this question. I have written a
three-part tutorial on using Boost at the beginning of this year. The
magazine I wrote these articles for ("iX", see http://www.ix.de) would be
willing to make them publicly available on their web page, if there would
be a link to them from the Boost web page. iX is one of the two flagship
products of Heise, which I believe are also known outside of Germany.

Note that these articles are in German language and refer to Boost 1.33 and
1.34.1 . However, as all available documentation for Boost seems to be in
English, these articles might help a few people. Please do let me know soon
if this is of interest and whom I should contact, so I can put him/her in
touch with the publication.

Best, Ruediger

------------------------------------------------------------------------
Dr. Ruediger Berlich               | E-mail: ruediger.berlich <at> iwr.fzk.de
Forschungszentrum Karlsruhe        | Web: http://ruediger.berlich.com
Steinbuch Centre for Computing     | Phone:  +49 (0)7247 825678
Hermann-von-Helmholtz-Platz 1      | Fax:    +49 (0)7247 824972
D-76344 Eggenstein-Leopoldshafen   | Mobile: +49 (0)178 5567842
------------------------------------------------------------------------

Forschungszentrum Karlsruhe GmbH
Sitz: Weberstraße 5
76133 Karlsruhe
Amtsgericht Mannheim HRB 100302
Vorsitzende des Aufsichtsrats: Bärbel Brumme-Bothe

Do the Boost documentation tools work on Cygwin?

According to  
http://www.boost.org/doc/libs/1_35_0/doc/html/boostbook/getting/started.html  
it's recommended to execute the script tools/boostbook/setup_boostbook.sh  
for an automatic installation and configuration of the Boost documentation  
tools. When I try it I get this:

$ ../boost_1_35_0/tools/boostbook/setup_boostbook.sh
../boost_1_35_0/tools/boostbook/setup_boostbook.sh: line 7: $'\r': command  
not found
../boost_1_35_0/tools/boostbook/setup_boostbook.sh: line 16: $'\r':  
command not found
../boost_1_35_0/tools/boostbook/setup_boostbook.sh: line 18: $'\r':  
command not found
../boost_1_35_0/tools/boostbook/setup_boostbook.sh: line 56: syntax error  
near unexpected token `$'do\r''
'./boost_1_35_0/tools/boostbook/setup_boostbook.sh: line 56: `for dir in  
$PATH; do

As there is a reference to Windows with Cygwin on  
http://www.boost.org/doc/libs/1_35_0/doc/html/boostbook/getting/started.html  
I expected the script to work on Cygwin. Can anyone tell me if this Cygwin  
is supported and the script supposed to work on Cygwin?

Boris

Quickbook for non-boost application

Hi all,

Yes I know this is supposed to be a boost specific mailing list, so if there
is a place where my question would fit in better, please point me to it.

First of all let me thank you for providing such great tools to help me
understand my programs even a year after I've written them.

My question is: What is a good way to set up a production line to make my
own documentation with QuickBook?

As far as I understand it the production line should be something like this:
quickbook doc.qbk  --> doc.xml
xslt doc.xml       --> some html files
Right?

For the first part (quickbook doc.qbk --> doc.xml) I have:
* downloaded QuickBook and compiled my own version as described
here
(http://www.boost.org/doc/libs/1_35_0/tools/quickbook/doc/html/quickbook/install/linux.html). 
* copied  
http://svn.boost.org/svn/boost/trunk/tools/quickbook/doc/quickbook.qbk to a
local doc.qbk and deleted most of it for test purposes
* generated doc.xml with quickbook executable

The second part (xslt doc.xml --> some html files) does not work for me so
far:
* doc.xml references a dtd file on the web that does not exist (fixed that
manually in the xml file to point to a local copy of boostbook.dtd, but for
future reference: where would one configure which dtd to reference?)

[quickbook] Several template bugs & Turing-completeness

Hi,

I've found several bugs regarding templates in Quickbook from 1.35 release:

1. This does not work:

[template sitelink[page name] [@http://site.org/[page] [name]]]
[sitelink index.html here] <- "error: Expanding template"

2. This causes access violation (memory write):

[template join1[a b] [b][a]] <- "error: Expanding template"
[template join2[a b] [a][b]]
[template test[x] [join1 [join2 0 [x]] 0]]
[test 0]

3. It would be nice if this worked:

[template t1 foo]
[template t2[t] [[t]]]
[t2 t1] <- "error: Expanding template"

4. Sometimes, when a matching ']' is missing, Quickbook hangs with 100% CPU
usage. However, I don't have any code snippet causing this right now.

BTW, in the docs there is a statement that Quickbook is Turing-complete. This
made me curious, but I haven't figured out yet how this works. Could somebody
send an example of some simple algorithm executed using Quickbook? Thanks in
advance. 

[boostbook] class free-function-group synopsis patch

Attached is a one-line patch that prevents a class' associated free functions 
(a "free-function-group" element inside a "class" element) from reappearing 
in the synopsis of member classes.  That is, for something like

<class name="A">
  <class name="AMemberClass"/>
  <free-function-group name="A's free functions"/>
</class>

"A's free functions" will currently appear both in the synopsis of class "A" 
and the synopsis of class "AMemberClass".  This patch prevents them from 
appearing in the synopsis of "AMemberClass".

I'll commit the change to svn in a few days if I don't hear any objections.

--

-- 
Frank

_______________________________________________
Boost-docs mailing list
Boost-docs <at> lists.boost.org
http://lists.boost.org/mailman/listinfo.cgi/boost-docs

Generating slightly better filenames

I'm trying to improve the filenames created by boostbook. In the
xpressive documentation there's a file (http://tinyurl.com/436vx4)
with the impressive filename:

result_This(Cont,It,Value),typename disable_if_ mpl__or__ is_integral_
UNCVREF(It)_,is_same_ UNCVREF(It),UNCVREF(Value)_ _
___type__id1001524.html

The attached patch generates the slightly improved:

result_This(Cont,It,Value),typename_disable_if_mpl_or_is_integral_UNCVREF(It)_,is_same_UNCVREF(It),UNCVREF(Value)_type_id2392301.html

Spaces are converted to underscores, and consecutive underscores are
replaced with single underscores. It's a bit of a hack but it seems to
work okay.

I'll try to make further improvements at some point - such as not
including the 'typename' and truncating long type names like this but
that will require a better understanding of the xsl so I probably
won't get round to it for a while.

If there's a 1.35.1, I'll probably try to include something like this.

Daniel

_______________________________________________
Boost-docs mailing list
Boost-docs <at> lists.boost.org