You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by Emmanuel Lecharny <el...@gmail.com> on 2011/10/19 19:06:16 UTC
LDAP API user guide : pdf available
Hi guys,
I have spent my day switching the LDAP API documentation from confluence
to the new system Stefan has tested. It works like a charm !
I have created a PDF from the files you can find in
*https://svn.apache.org/repos/asf/directory
<http://svn.apache.org/viewvc/directory/>/documentation
<http://svn.apache.org/viewvc/directory/documentation/>/ldap-api-manuals
<http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/>/trunk*,
and it has also been generated on /www/directory.apache.org/api.
Here is the available PDF :
http://people.apache.org/~elecharny/book.pdf
Ok it's not perfect yet :
- first a hell lot of documentation is missing...
- the links are'nt correctly generated (we have the text twice)
- we have some text larger than the pages
- If we have text after an image, there is a line break between the
image and the text
but the overall result is quite ok...
Feedback welcomed !
--
Regards,
Cordialement,
Emmanuel Lécharny
www.iktek.com
Re: LDAP API user guide : pdf available
Posted by Pierre-Arnaud Marcelot <pa...@marcelot.net>.
This is, indeed, looking very good.
A few tweaks here and there in the stylesheet generating the PDF and HTML files, and we're good for the visual part.
Content creation will probably take longer (wiki-style text will help speed things up though).
I have to see how we can move our Studio hel plugins to use the new markup. It would be better to have all our documentation under the same format.
Regards,
Pierre-Arnaud
On 19 oct. 2011, at 19:36, Felix Knecht wrote:
> On 10/19/2011 07:06 PM, Emmanuel Lecharny wrote:
>> Hi guys,
>>
>> I have spent my day switching the LDAP API documentation from confluence
>> to the new system Stefan has tested. It works like a charm !
>>
>> I have created a PDF from the files you can find in
>> *https://svn.apache.org/repos/asf/directory
>> <http://svn.apache.org/viewvc/directory/>/documentation
>> <http://svn.apache.org/viewvc/directory/documentation/>/ldap-api-manuals
>> <http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/>/trunk*,
>> and it has also been generated on /www/directory.apache.org/api.
>>
>> Here is the available PDF :
>>
>> http://people.apache.org/~elecharny/book.pdf
>>
>>
>> Ok it's not perfect yet :
>> - first a hell lot of documentation is missing...
>> - the links are'nt correctly generated (we have the text twice)
>> - we have some text larger than the pages
>> - If we have text after an image, there is a line break between the
>> image and the text
>>
>> but the overall result is quite ok...
>>
>> Feedback welcomed !
>
> Looks good :-)
> Why didn't we came to this solution before I did the docbook stuff ... :-/
>
Re: LDAP API user guide : pdf available
Posted by Alex Karasulu <ak...@apache.org>.
Yes this looks great minor kinks that can be worked out later aside.
Great job!
ALex
On Wed, Oct 19, 2011 at 8:36 PM, Felix Knecht <fe...@apache.org> wrote:
> On 10/19/2011 07:06 PM, Emmanuel Lecharny wrote:
>
>> Hi guys,
>>
>> I have spent my day switching the LDAP API documentation from confluence
>> to the new system Stefan has tested. It works like a charm !
>>
>> I have created a PDF from the files you can find in
>> *https://svn.apache.org/repos/**asf/directory<https://svn.apache.org/repos/asf/directory>
>> <http://svn.apache.org/viewvc/**directory/<http://svn.apache.org/viewvc/directory/>
>> >/documentation
>> <http://svn.apache.org/viewvc/**directory/documentation/<http://svn.apache.org/viewvc/directory/documentation/>
>> >/**ldap-api-manuals
>> <http://svn.apache.org/viewvc/**directory/documentation/ldap-**
>> api-manuals/<http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/>
>> >/trunk*,
>> and it has also been generated on /www/directory.apache.org/api.
>>
>> Here is the available PDF :
>>
>> http://people.apache.org/~**elecharny/book.pdf<http://people.apache.org/~elecharny/book.pdf>
>>
>>
>> Ok it's not perfect yet :
>> - first a hell lot of documentation is missing...
>> - the links are'nt correctly generated (we have the text twice)
>> - we have some text larger than the pages
>> - If we have text after an image, there is a line break between the
>> image and the text
>>
>> but the overall result is quite ok...
>>
>> Feedback welcomed !
>>
>
> Looks good :-)
> Why didn't we came to this solution before I did the docbook stuff ... :-/
>
>
--
Best Regards,
-- Alex
Re: LDAP API user guide : pdf available
Posted by Emmanuel Lecharny <el...@gmail.com>.
On 10/19/11 7:36 PM, Felix Knecht wrote:
> On 10/19/2011 07:06 PM, Emmanuel Lecharny wrote:
>> Hi guys,
>>
>> I have spent my day switching the LDAP API documentation from confluence
>> to the new system Stefan has tested. It works like a charm !
>>
>> I have created a PDF from the files you can find in
>> *https://svn.apache.org/repos/asf/directory
>> <http://svn.apache.org/viewvc/directory/>/documentation
>> <http://svn.apache.org/viewvc/directory/documentation/>/ldap-api-manuals
>> <http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/>/trunk*,
>>
>> and it has also been generated on /www/directory.apache.org/api.
>>
>> Here is the available PDF :
>>
>> http://people.apache.org/~elecharny/book.pdf
>>
>>
>> Ok it's not perfect yet :
>> - first a hell lot of documentation is missing...
>> - the links are'nt correctly generated (we have the text twice)
>> - we have some text larger than the pages
>> - If we have text after an image, there is a line break between the
>> image and the text
>>
>> but the overall result is quite ok...
>>
>> Feedback welcomed !
>
> Looks good :-)
> Why didn't we came to this solution before I did the docbook stuff ...
> :-/
Meh... Don't ask !
I spent a hell of time last year trying to get a grip on docbook and
XML, just enough to want to throw my computer through the windows...
Hopefully, I wasn't using windows !
--
Regards,
Cordialement,
Emmanuel Lécharny
www.iktek.com
Re: LDAP API user guide : pdf available
Posted by Felix Knecht <fe...@apache.org>.
On 10/19/2011 07:06 PM, Emmanuel Lecharny wrote:
> Hi guys,
>
> I have spent my day switching the LDAP API documentation from confluence
> to the new system Stefan has tested. It works like a charm !
>
> I have created a PDF from the files you can find in
> *https://svn.apache.org/repos/asf/directory
> <http://svn.apache.org/viewvc/directory/>/documentation
> <http://svn.apache.org/viewvc/directory/documentation/>/ldap-api-manuals
> <http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/>/trunk*,
> and it has also been generated on /www/directory.apache.org/api.
>
> Here is the available PDF :
>
> http://people.apache.org/~elecharny/book.pdf
>
>
> Ok it's not perfect yet :
> - first a hell lot of documentation is missing...
> - the links are'nt correctly generated (we have the text twice)
> - we have some text larger than the pages
> - If we have text after an image, there is a line break between the
> image and the text
>
> but the overall result is quite ok...
>
> Feedback welcomed !
Looks good :-)
Why didn't we came to this solution before I did the docbook stuff ... :-/
Re: LDAP API user guide : pdf available
Posted by Howard Chu <hy...@symas.com>.
Emmanuel Lecharny wrote:
> On 10/20/11 12:25 AM, Howard Chu wrote:
>> Did a quick read thru the first couple sections, fixed some simple
>> typos and such.
>
> Thanks Howard ! It's really a preliminary version, with *many* parts
> missing, and a lot of review to be done. More or less, it was to check
> if the tooling we are using to generate the PDF is working, and I'm
> quite pleased by the resulting document.
Yes, understood. A while back we were looking at converting the OpenLDAP Admin
Guide into Docbook format, so I was curious to see how your new setup worked.
(And of course I'm curious to see the new API as well. ;)
--
-- Howard Chu
CTO, Symas Corp. http://www.symas.com
Director, Highland Sun http://highlandsun.com/hyc/
Chief Architect, OpenLDAP http://www.openldap.org/project/
Re: LDAP API user guide : pdf available
Posted by Emmanuel Lecharny <el...@gmail.com>.
On 10/20/11 12:25 AM, Howard Chu wrote:
> Emmanuel Lecharny wrote:
>> Hi guys,
>>
>> I have spent my day switching the LDAP API documentation from confluence
>> to the new system Stefan has tested. It works like a charm !
>>
>> I have created a PDF from the files you can find in
>> *https://svn.apache.org/repos/asf/directory
>> <http://svn.apache.org/viewvc/directory/>/documentation
>> <http://svn.apache.org/viewvc/directory/documentation/>/ldap-api-manuals
>> <http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/>/trunk*,
>>
>> and it has also been generated on /www/directory.apache.org/api.
>>
>> Here is the available PDF :
>>
>> http://people.apache.org/~elecharny/book.pdf
>>
>>
>> Ok it's not perfect yet :
>> - first a hell lot of documentation is missing...
>> - the links are'nt correctly generated (we have the text twice)
>> - we have some text larger than the pages
>> - If we have text after an image, there is a line break between the
>> image and the text
>>
>> but the overall result is quite ok...
>>
>> Feedback welcomed !
>>
> Did a quick read thru the first couple sections, fixed some simple
> typos and such.
Thanks Howard ! It's really a preliminary version, with *many* parts
missing, and a lot of review to be done. More or less, it was to check
if the tooling we are using to generate the PDF is working, and I'm
quite pleased by the resulting document.
--
Regards,
Cordialement,
Emmanuel Lécharny
www.iktek.com
Re: LDAP API user guide : pdf available
Posted by Howard Chu <hy...@symas.com>.
Emmanuel Lecharny wrote:
> Hi guys,
>
> I have spent my day switching the LDAP API documentation from confluence
> to the new system Stefan has tested. It works like a charm !
>
> I have created a PDF from the files you can find in
> *https://svn.apache.org/repos/asf/directory
> <http://svn.apache.org/viewvc/directory/>/documentation
> <http://svn.apache.org/viewvc/directory/documentation/>/ldap-api-manuals
> <http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/>/trunk*,
> and it has also been generated on /www/directory.apache.org/api.
>
> Here is the available PDF :
>
> http://people.apache.org/~elecharny/book.pdf
>
>
> Ok it's not perfect yet :
> - first a hell lot of documentation is missing...
> - the links are'nt correctly generated (we have the text twice)
> - we have some text larger than the pages
> - If we have text after an image, there is a line break between the
> image and the text
>
> but the overall result is quite ok...
>
> Feedback welcomed !
>
Did a quick read thru the first couple sections, fixed some simple typos and such.
--
-- Howard Chu
CTO, Symas Corp. http://www.symas.com
Director, Highland Sun http://highlandsun.com/hyc/
Chief Architect, OpenLDAP http://www.openldap.org/project/
Re: LDAP API user guide : pdf available
Posted by Oliver Schmidt <ol...@arcor.de>.
Am 19.10.2011, 19:06 Uhr, schrieb Emmanuel Lecharny <el...@gmail.com>:
> Hi guys,
>
> I have spent my day switching the LDAP API documentation from confluence
> to the new system Stefan has tested. It works like a charm !
>
> I have created a PDF from the files you can find in
> *https://svn.apache.org/repos/asf/directory
> <http://svn.apache.org/viewvc/directory/>/documentation
> <http://svn.apache.org/viewvc/directory/documentation/>/ldap-api-manuals
> <http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/>/trunk*,
> and it has also been generated on /www/directory.apache.org/api.
>
> Here is the available PDF :
>
> http://people.apache.org/~elecharny/book.pdf
>
>
> Ok it's not perfect yet :
> - first a hell lot of documentation is missing...
> - the links are'nt correctly generated (we have the text twice)
> - we have some text larger than the pages
> - If we have text after an image, there is a line break between the
> image and the text
>
> but the overall result is quite ok...
>
> Feedback welcomed !
>
Looks really good! In code blocks the text flows out of the boxes but I
think this is no big issue...