You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by Ersin Er <er...@gmail.com> on 2007/02/05 09:56:34 UTC
[ApacheDS][Documentation] Changes to internal composition of the Basic User's Guide
Hi all,
I tried to improve the composition of the Basic User's Guide (BUG) by
using some Confluence macros. Here is the list of changes I made over
all the document:
* Created intermedia navigation pages to reflect the hierarchical
structure of the guide.
* Moved all content pages under related intermediate pages.
* Used children macros in all these intermedia pages.
* Used scrollbar macros in all pages.
* Replaced hand crafted TOC in the main document page with a children macro.
* Replaced all hand crafted TOCs and anchor entries in all content
pages with toc macros.
After the new organization something a bir disturbing is the
navigation structure which does not create next/previous links to
pages of upper levels. See this problem here for example:
http://directory.apache.org/apacheds/1.0/15-about-the-sample-configurations-and-sample-directory-data.html
But I think it's not very critical. Currently the structure of the
guide is more flexible to changes and includes less wiki code to
maintain.
We may try to improve it more or build some previous constructs again
if you have any suggestions.
--
Ersin
Re: [ApacheDS][Documentation] Changes to internal composition of the Basic User's Guide
Posted by Ersin Er <er...@gmail.com>.
On 2/5/07, Stefan Zoerner <st...@labeo.de> wrote:
> Hi Ersin,
>
> This is really great work. I am happy to see the content published that
> way, hopefully helping many new users to get started.
>
> One Question:
> Currently, the title of a BUG page is not displayed within the content
> area, only as window title, for instance
>
> http://directory.apache.org/apacheds/1.0/31-authentication-options.html
>
> Window title is
> Apache Directory Server v1.0 - 3.1. Authentication options
>
> Is it possible to have the page title ("Authentication options" in this
> case, perhaps with number) in the content area as well, perhaps below
> the navigation? And if it is not possible to generate this with the help
> of the template, do you have a recommendation which markup to use to add
> it to the pages by hand?
I have already searched for a solution for this requirement. I could
not find a "good" solution, so today I put all page titles inside the
pages just as you proposed. I think I forgot doing this in some pages.
So we need to put them all by hand as I did here:
http://directory.apache.org/apacheds/1.0/2-handling-of-data-within-your-directory.html
> Thanks in advance,
> Stefan
--
Ersin
Re: [ApacheDS][Documentation] Changes to internal composition of
the Basic User's Guide
Posted by Stefan Zoerner <st...@labeo.de>.
Ersin Er wrote:
>
> Well, I think it's possible to do this with template but do we want
> this in the same style on all pages really ?
>
I have started to at a heading on the page by hand.
For instance
--8<--
{scrollbar}
h1. Installing and starting the server
This section describes how ApacheDS can be installed and started at
different platforms.
-->8--
I have omitted the numbers from the page title, so it is easier to keep
them consistent ...
Greetings, Stefan
Re: [ApacheDS][Documentation] Changes to internal composition of the Basic User's Guide
Posted by Ersin Er <er...@gmail.com>.
On 2/5/07, Stefan Zoerner <st...@labeo.de> wrote:
> One Question:
> Currently, the title of a BUG page is not displayed within the content
> area, only as window title, for instance
>
> http://directory.apache.org/apacheds/1.0/31-authentication-options.html
>
> Window title is
> Apache Directory Server v1.0 - 3.1. Authentication options
>
> Is it possible to have the page title ("Authentication options" in this
> case, perhaps with number) in the content area as well, perhaps below
> the navigation? And if it is not possible to generate this with the help
> of the template, do you have a recommendation which markup to use to add
> it to the pages by hand?
Well, I think it's possible to do this with template but do we want
this in the same style on all pages really ?
--
Ersin
Re: [ApacheDS][Documentation] Changes to internal composition of
the Basic User's Guide
Posted by Stefan Zoerner <st...@labeo.de>.
Hi Ersin,
This is really great work. I am happy to see the content published that
way, hopefully helping many new users to get started.
One Question:
Currently, the title of a BUG page is not displayed within the content
area, only as window title, for instance
http://directory.apache.org/apacheds/1.0/31-authentication-options.html
Window title is
Apache Directory Server v1.0 - 3.1. Authentication options
Is it possible to have the page title ("Authentication options" in this
case, perhaps with number) in the content area as well, perhaps below
the navigation? And if it is not possible to generate this with the help
of the template, do you have a recommendation which markup to use to add
it to the pages by hand?
Thanks in advance,
Stefan
Re: [ApacheDS][Documentation] Changes to internal composition of the Basic User's Guide
Posted by Ole Ersoy <ol...@yahoo.com>.
Ah - OK - Well - It looks fantastic. Kudos all around
:-)
--- Ersin Er <er...@gmail.com> wrote:
> Don't take me wrong. It was already looking good
> after Stefan's and
> Christine's works. I just improved its internals.
>
> On 2/5/07, Ole Ersoy <ol...@yahoo.com> wrote:
> > Wow - Looks really good Ersin. I have to
> understand
> > the technical details more, but the end result
> rocks!
> > :-)
> >
> >
> > --- Ersin Er <er...@gmail.com> wrote:
> >
> > > Hi all,
> > >
> > > I tried to improve the composition of the Basic
> > > User's Guide (BUG) by
> > > using some Confluence macros. Here is the list
> of
> > > changes I made over
> > > all the document:
> > >
> > > * Created intermedia navigation pages to reflect
> the
> > > hierarchical
> > > structure of the guide.
> > > * Moved all content pages under related
> intermediate
> > > pages.
> > > * Used children macros in all these intermedia
> > > pages.
> > > * Used scrollbar macros in all pages.
> > > * Replaced hand crafted TOC in the main document
> > > page with a children macro.
> > > * Replaced all hand crafted TOCs and anchor
> entries
> > > in all content
> > > pages with toc macros.
> > >
> > > After the new organization something a bir
> > > disturbing is the
> > > navigation structure which does not create
> > > next/previous links to
> > > pages of upper levels. See this problem here for
> > > example:
> > >
> > >
> >
>
http://directory.apache.org/apacheds/1.0/15-about-the-sample-configurations-and-sample-directory-data.html
> > >
> > > But I think it's not very critical. Currently
> the
> > > structure of the
> > > guide is more flexible to changes and includes
> less
> > > wiki code to
> > > maintain.
> > >
> > > We may try to improve it more or build some
> previous
> > > constructs again
> > > if you have any suggestions.
> > >
> > > --
> > > Ersin
> > >
> >
> >
> >
> >
> >
>
____________________________________________________________________________________
> > 8:00? 8:25? 8:40? Find a flick in no time
> > with the Yahoo! Search movie showtime shortcut.
> > http://tools.search.yahoo.com/shortcuts/#news
> >
>
>
> --
> Ersin
>
____________________________________________________________________________________
Sucker-punch spam with award-winning protection.
Try the free Yahoo! Mail Beta.
http://advision.webevents.yahoo.com/mailbeta/features_spam.html
Re: [ApacheDS][Documentation] Changes to internal composition of the Basic User's Guide
Posted by Ersin Er <er...@gmail.com>.
Don't take me wrong. It was already looking good after Stefan's and
Christine's works. I just improved its internals.
On 2/5/07, Ole Ersoy <ol...@yahoo.com> wrote:
> Wow - Looks really good Ersin. I have to understand
> the technical details more, but the end result rocks!
> :-)
>
>
> --- Ersin Er <er...@gmail.com> wrote:
>
> > Hi all,
> >
> > I tried to improve the composition of the Basic
> > User's Guide (BUG) by
> > using some Confluence macros. Here is the list of
> > changes I made over
> > all the document:
> >
> > * Created intermedia navigation pages to reflect the
> > hierarchical
> > structure of the guide.
> > * Moved all content pages under related intermediate
> > pages.
> > * Used children macros in all these intermedia
> > pages.
> > * Used scrollbar macros in all pages.
> > * Replaced hand crafted TOC in the main document
> > page with a children macro.
> > * Replaced all hand crafted TOCs and anchor entries
> > in all content
> > pages with toc macros.
> >
> > After the new organization something a bir
> > disturbing is the
> > navigation structure which does not create
> > next/previous links to
> > pages of upper levels. See this problem here for
> > example:
> >
> >
> http://directory.apache.org/apacheds/1.0/15-about-the-sample-configurations-and-sample-directory-data.html
> >
> > But I think it's not very critical. Currently the
> > structure of the
> > guide is more flexible to changes and includes less
> > wiki code to
> > maintain.
> >
> > We may try to improve it more or build some previous
> > constructs again
> > if you have any suggestions.
> >
> > --
> > Ersin
> >
>
>
>
>
> ____________________________________________________________________________________
> 8:00? 8:25? 8:40? Find a flick in no time
> with the Yahoo! Search movie showtime shortcut.
> http://tools.search.yahoo.com/shortcuts/#news
>
--
Ersin
Re: [ApacheDS][Documentation] Changes to internal composition of the Basic User's Guide
Posted by Ole Ersoy <ol...@yahoo.com>.
Wow - Looks really good Ersin. I have to understand
the technical details more, but the end result rocks!
:-)
--- Ersin Er <er...@gmail.com> wrote:
> Hi all,
>
> I tried to improve the composition of the Basic
> User's Guide (BUG) by
> using some Confluence macros. Here is the list of
> changes I made over
> all the document:
>
> * Created intermedia navigation pages to reflect the
> hierarchical
> structure of the guide.
> * Moved all content pages under related intermediate
> pages.
> * Used children macros in all these intermedia
> pages.
> * Used scrollbar macros in all pages.
> * Replaced hand crafted TOC in the main document
> page with a children macro.
> * Replaced all hand crafted TOCs and anchor entries
> in all content
> pages with toc macros.
>
> After the new organization something a bir
> disturbing is the
> navigation structure which does not create
> next/previous links to
> pages of upper levels. See this problem here for
> example:
>
>
http://directory.apache.org/apacheds/1.0/15-about-the-sample-configurations-and-sample-directory-data.html
>
> But I think it's not very critical. Currently the
> structure of the
> guide is more flexible to changes and includes less
> wiki code to
> maintain.
>
> We may try to improve it more or build some previous
> constructs again
> if you have any suggestions.
>
> --
> Ersin
>
____________________________________________________________________________________
8:00? 8:25? 8:40? Find a flick in no time
with the Yahoo! Search movie showtime shortcut.
http://tools.search.yahoo.com/shortcuts/#news