Re: [fw-general] Component documentation & APIs
Hey Darby,
Thanks for you feedback and kind words!
I modified everything so it uses a page template now. Makes it easier to
modify things afterwards :-). I also put the sidebar to the right, so
you can see if it's better. Personally I kinda like it better this way.
The updated pages can be found here:
http://framework.zend.com/wiki/display/ZFDOCDEV/Home
I will have a look at the suggestions you've made below.
Best regards,
Andries Seutens
Belgium
http://andries.systray.be
Darby Felton schreef:
Hi Andries,
Andries Seutens wrote:
I'm not sure if it's possible to add a tab to the wiki space. I'll have
to check with Gavin or Darby for this. Gavin, Darby?
Honestly, I'm not sure how this would be done the way I think you mean,
though perhaps it is possible. Maybe the {deck} and {card} wiki tags, as
seen on:
http://framework.zend.com/wiki/renderer/notationhelp.action?section=advanced
would meet the end goals you had in mind?
I have a few more notes/questions:
- Leave the sidebar on the left of the page or put it on the right side
of the page?
I would like to see it on the right side of the page, since expanding
long class names results in the left-most side of the main manual
content being pushed to the right. I think it would be better if
expansion of sidebar content would only result text wrapping changes to
the main manual content. I hope that makes sense, though I also think
that the converse could be said for right-to-left languages. :-/
- Is it possible to hide the navigation bar when printing/exporting to pdf?
Maybe try the {hide-if} tag? (also on advanced editing help page)
- Some of our component names are so long that they don't fit in the
sidebar, what should we do with that? (less padding would be one)
I see the component names wrapping at the edge of the sidebar (maybe
we're talking about the same thing). Just guessing, but maybe using CSS
"white-space:nowrap" (or something similar) would work?
- I couldn't keep the links from the docbook alive, as the page
structure is a lot different (more content on one page, less clicking,
more scrolling) do you guys mind?
I see that even links to outside resources have been lost, such as the
include() and include_once() links to php.net on
http://framework.zend.com/manual/en/zend.loadfile.html. I think at least
these are important to have propagated, since they generally link to
information only available outside the scope of our manual. What is the
technical limitation encountered here, so that we all could understand
how it might be solved?
- The {toc} macro seems to have problems with heading with the same name
(wrong anchor links)
I believe that the {toc-zone} lets you get around this problem by
specifying to which content the macro applies.
For those of you that don't know yet, the wiki import test can be found
here:
http://framework.zend.com/wiki/display/ZFDOCDEV/Home
Overall, this is great work, Andries, and I'm sure I speak not only for
myself when I say *thank you!*
Best regards,
Darby
Re: [fw-general] Component documentation & APIs
Hi Andries,
Andries Seutens wrote:
> I'm not sure if it's possible to add a tab to the wiki space. I'll have
> to check with Gavin or Darby for this. Gavin, Darby?
Honestly, I'm not sure how this would be done the way I think you mean,
though perhaps it is possible. Maybe the {deck} and {card} wiki tags, as
seen on:
http://framework.zend.com/wiki/renderer/notationhelp.action?section=advanced
would meet the end goals you had in mind?
> I have a few more notes/questions:
>
> - Leave the sidebar on the left of the page or put it on the right side
> of the page?
I would like to see it on the right side of the page, since expanding
long class names results in the left-most side of the main manual
content being pushed to the right. I think it would be better if
expansion of sidebar content would only result text wrapping changes to
the main manual content. I hope that makes sense, though I also think
that the converse could be said for right-to-left languages. :-/
> - Is it possible to hide the navigation bar when printing/exporting to pdf?
Maybe try the {hide-if} tag? (also on advanced editing help page)
> - Some of our component names are so long that they don't fit in the
> sidebar, what should we do with that? (less padding would be one)
I see the component names wrapping at the edge of the sidebar (maybe
we're talking about the same thing). Just guessing, but maybe using CSS
"white-space:nowrap" (or something similar) would work?
> - I couldn't keep the links from the docbook alive, as the page
> structure is a lot different (more content on one page, less clicking,
> more scrolling) do you guys mind?
I see that even links to outside resources have been lost, such as the
include() and include_once() links to php.net on
http://framework.zend.com/manual/en/zend.loadfile.html. I think at least
these are important to have propagated, since they generally link to
information only available outside the scope of our manual. What is the
technical limitation encountered here, so that we all could understand
how it might be solved?
> - The {toc} macro seems to have problems with heading with the same name
> (wrong anchor links)
I believe that the {toc-zone} lets you get around this problem by
specifying to which content the macro applies.
> For those of you that don't know yet, the wiki import test can be found
> here:
>
> http://framework.zend.com/wiki/display/ZFDOCDEV/Home
Overall, this is great work, Andries, and I'm sure I speak not only for
myself when I say *thank you!*
Best regards,
Darby
Re: [fw-general] Component documentation & APIs
Hello Simon,
Thank you for your nice words!
I'm not sure if it's possible to add a tab to the wiki space. I'll have
to check with Gavin or Darby for this. Gavin, Darby?
I have a few more notes/questions:
- Leave the sidebar on the left of the page or put it on the right side
of the page?
- Is it possible to hide the navigation bar when printing/exporting to pdf?
- Some of our component names are so long that they don't fit in the
sidebar, what should we do with that? (less padding would be one)
- I couldn't keep the links from the docbook alive, as the page
structure is a lot different (more content on one page, less clicking,
more scrolling) do you guys mind?
- The {toc} macro seems to have problems with heading with the same name
(wrong anchor links)
For those of you that don't know yet, the wiki import test can be found
here:
http://framework.zend.com/wiki/display/ZFDOCDEV/Home
If you have comments, please send them to the mailing list instead of
posting them in the wiki space (pages get deleted now and then)
Best regards,
Andries Seutens
Belgium
http://andries.systray.be
Simon Mundy schreef:
Hi Andries
Just wanted to say nice work on the new wiki-style docs - it's a lot
more accessible with the collapsible folders.
I have a request, but wasn't sure of how much work it would be to have
tabs associated with the documentation. The default tab is what you
have now, the middle could be the docbook APIs and the final one could
be developer notes. That way it'd be easier to cross reference the
documentation for beginners and the ones with poor memory recall (i.e.
me :) )
If it's a big ask then I don't expect you to put any time into it
(you've already put a lot in for the wiki conversion itself) but just
wanted to put the question out there to see if it's possible.
Cheers
--
Simon Mundy | Director | PEPTOLAB
""" " "" "" "" "" """ " "" " " " " "" "" "
202/258 Flinders Lane | Melbourne | Victoria | Australia | 3000
Voice +61 (0) 3 9654 4324 | Mobile 0438 046 061 | Fax +61 (0) 3 9654 4124
http://www.peptolab.com
