Re: Using entities for the examples
| From: | Philip Olson | Date: | Wed, 04 Aug 2004 15:01:05 +0000 |
| Subject: | Re: Using entities for the examples | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969362623@lists.php.net to get a copy of this message | ||
> >>>>><!ENTITY example.outputs '<para>The above example(s) will
> >>>>>output:'>
> >>>>
> >>>>No please. I don't like (s).
> >>>
> >>>Yup, we should treat those one by hand :)
> >>
> >>(s) is horrible!
> >
> > What about:
> >
> > <!ENTITY example.outputs '<para>The above will
> > output:</para>'>
> >
> > Or, putting the (will be/similar to) together in a more general form:
> >
> > <!ENTITY example.outputs '<para>The above output will be (at least similar
> > to):</para>'>
>
> No good. There are outputs which exactly display what should happen, and
> there are outputs which are close to that. No need to merge the two as
> it would lead to confusion IMHO.
Also, I don't think people will get confused if there are
multiple outputs (examples) within the above example to worry
about an 's' or not. Simply have one entity for output and
one for similar, that's it. Being that these are used under just
one <example> tag makes this especially true.
Regards,
Philip