Re: See also
| From: | Gabor Hojtsy | Date: | Mon, 14 Jan 2002 18:52:52 +0000 |
| Subject: | Re: See also | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969341212@lists.php.net to get a copy of this message | ||
> > > If I understand it correctly, see-also block is very simillar to
> > > admonitions (note, warning, ...). So what about putting see-also
inside
> > > note
> > >
> > > <note role="seealso">
> > > ...
> > > </note>
> > >
> > > Stylesheet can render it differently than note w/o role="seealso".
> >
> > As nobody else complained, I think we can go on with this style.
> > Please make a DSSSL customization for this as you have the time,
> > and then we can start experimenting with it, by adding see also
> > parts this way.
>
> What is the exact syntax, will we still be defining commas and 'and'
> within the blocks?
Yes. It seems that using lists is much more complex for the rendering,
as it involves adding commas and and words only where needed
programatically.
<note role="seealso">
<function>print</function>, and
<function>echo</function>
</note>
does not look that nice, as
<somelisttag role="seealso">
<function>print</function>
<function>echo</function>
</somelisttag>
but the note form allows us to do things like this:
<note role="seealso">
<function>print</function>, and
the notes on the <link linkend="secutity.cgi">CGI
security page</link>
</note>
Either we choose "note" or "somelisttag", it is better
than the current style. I have not seen too many
comments about this on the list so far...
Goba