[ZDP] Congratulations, nitpicking and suggestions

Alexandre Ratti alex@gabuzomeu.net
Wed, 08 Mar 2000 00:20:28 +0100


Hello,


At 05:41 06/03/2000 -0800, you wrote:
>Date: Mon, 06 Mar 2000 14:43:26 +0100
>From: Maik Roeder <roeder@berg.net>
>Subject: Re: [ZDP] Congratulations, nitpicking and suggestions

> > I like the link items in the FAQ system, too: that's very useful to point
> > new users to in-depth documentation.
>
>I may change this a little bit, making this flat view optional and without
>the links. I am having problems integrating all the management stuff into
>one view,

I suppose you're refering to the yellow admin area that contains a lot of 
links.
Have you considered creating an additional narrow (eg. 3 cm) column on the 
right side of the window to store all these links? This column would only 
show when the viewer has admin rights. Then the admin area would take as 
much screen space.

>because here we could have the following Management interfaces on
>one page together with all their respective services like Comments, Links
>and so forth.
>
>1. FAQ Section
>2. FAQ Question
>3. FAQ Answer
>
>I think it is best to have a list of questions and when you click on the
>question you see the Question plus the Answer.

Plus the links / related info?

Would you still be able to print out easily all questions and answers 
within the section? I think this is important. It could be done from a 
separate page with a different template, though.

>This default view would then
>have the links to in-depth documentation, just like every other page has.


> > - On the <http://zdp.zope.org/projects/zfaq/faq/DTML> page, the page
> > display is too wide. This will be a problem for people using low-resolution
> > display.
>
>I don't think we are using fixed Table width. Must have to do with the
><PRE> stuff.

Yes, probably. This isn't easily solved: PRE code examples would need to be 
manually edited to wrap long lines.

> > Also, the page doesn't print properly on A4 (standard European) paper. I
> > think this is caused by the PRE formatting for code examples, which
> > prevents wrapping.
>
>Examples should be changed so that this does not occur.
>
> > One solution is to provide a "printable page" alternate layout where the
> > left-side link column isn't included.
>
>Sure, this is needed. It should be easy to create a new Template in the
>DocumentFolder ZClass and show this one when the "printable page" link
>is hit. You can change this in:
>
>/Control_Panel/Products/DocumentFolderProduct/DocumentFolderClass
>
>Have a look at the standard Template, then create a Printing_Template,
>and add a link to standard_html_footer in the root of ZDP, just like
>on zope.org.

OK, I added a printing template in "DocumentFolderClass", I added 
standard_printing_header and standard_printing_footer in the root and I 
included a link to the printing template in the standard_html_footer.
It's working, though I'll need to prettify it a bit.


>  > - Also, I goofed: I failed to provide a number in front of the FAQ Section
> > name ("ZClasses") because I expected it to be automatically generated.
>
>That would be best, but unfortunately the order problem is as of yet 
>unresolved.
>
> > Manual numbers do make sense because you can use them to sort the section
> > titles in a natural way (so that Zope Installation is listed before Zope
> > API for instance).
> > You may want to specify in the Add Section form that a number is needed.
> > (Or did I miss the explaination?).
>
>I also think that when we change your entry to 10. ZClasses, it will be
>displayed as number one in the list :-)

No, interestingly: I changed the Section name to "10. Zclasses" and the 
entry is correctly listed at the last position.

>I think that Zope should provide
>a way to keep an order on Folder items. Perhaps you know about a solution ?

I remember Itamar published a patch a few months ago to allow sorting 
objects listed in the Zope UI. I'll send it over to you by private email if 
you're interested. I don't really understand how it works.

>
> > - How can I add a link ? I'd like to add a link near the answer to the
> > question "What are ZClasses? (see
> > <http://zdp.zope.org/projects/zfaq/faq/ZClasses>).
>
>First, you would have to add a WebSiteLinkFolder, but anonymous users don't
>have the right to do this, because we have to keep a certain naming
>convention. This can change in future, when we make it possible to
>add generic WebSiteLinkFolders with predefined names.

OK, I added a LinkFolder called links as in other Answers and a Link. They 
display OK.

What naming conventions are you refering too? Conventions for ids or names 
or nicknames?


> > - In the Add Answer form, I suggest providing a selection list to pick the
> > format (stx, html, etc.) to avoid typos.
>
>You can change the following:
>
>/Control_Panel/Products/DocumentFolderProduct/form_content _type

I'll test adding a list tomorrow morning.


> > - In the <http://zdp.zope.org/projects/zfaq/faq/ZClasses> page for
> > instance, a question / answer contributor name displays as "Contributed by
> > visitor AlexR (alex@gabuzomeu.net)". Instead of showing the email address
> > as text, I suggest creating a link from the contributor name to save screen
> > space.
>
>The text "AlexR (alex@gabuzomeu.net)" is completely stored in the Maintainer
>field. I don't know if it is good to put some HTML in there like:
>"<A HREF="mailto:AlexR>alex@gabuzomeu.net</A>, but if you think this is ok,
>we may change this.

I'm not sure. Maybe we'd better avoid storing HTML markups in the property 
fields for easier reuse. Either we try using two properties (I haven't 
looked at the code yet) or we live it as is. There's no rush anyway.

>
>You can change:
>
>/Control_Panel/Products/DocumentFolderProduct/Set_Maintainer_To_Visitor


Cheers.

Alexandre

>Maik Röder