[PHP-DOC] Bug #7888 Updated: decrement syntax should be -- instead of - From: hholzgra <email protected>
Date: 09/23/01

ID: 7888
Updated by: hholzgra
Reported By: jgoulooze <email protected>
Old Status: Closed
Status: Analyzed
Bug Type: Documentation problem
Operating System: NT & win98 using apache (phptria
PHP Version: 4.0.2
Assigned To: hholzgra
New Comment:

as long as we produce manual versions
with missleading output of '--'
this *is* a documentation bug

it is not our fault that it shows up
as the real cause for it is a shortcoming
of Jade which doesn't take in account
that '--' has a special meaning in
TeX and doesn't add escape characters
or sequences to prevent this, but as
we prodcude the wrong output with the
current toolchain it *is* a documentation
bug, problem, misfeature ... whatever ...
after all

so this report should not be closed unless
we get a non-ugly solution for it

whe can talk about 'suspended' with jah's
dirty hack in place, but definetly not
about 'closed' as the problem isn't solved
yet!

Previous Comments:
------------------------------------------------------------------------

[2001-09-23 09:17:48] goba <email protected>

I think Egon meant:

| This means, you cannot write a "<" character
| __outside__ a CDATA section of any XML file.
| Only ">" is allowed.

Extract from:
http://www.w3.org/TR/2000/REC-xml-20001006#sec-cdata-sect

| Within a CDATA section, only the CDEnd string is
| recognized as markup, so that left angle brackets and
| ampersands may occur in their literal form; they need
| not (and cannot) be escaped using "&lt;" and "&amp;".

So people can use < in CDATA. Outside CDATA, they can't. 

--
Goba

------------------------------------------------------------------------

[2001-09-23 09:06:42] eschmid <email protected>

This "bug" is not a documentation problem. Building PostScript or PDF manuals with xml files renders two dashes into a long dash. This is a problem with Jade because it uses TeX. 

The "<" is another case. It is the first character for an element name in XML. This means, you cannot write a "<" character in the CDATA section of any XML file. Only ">" is allowed.

Please use the mailinglist archives, it was discussed several times.

------------------------------------------------------------------------

[2001-09-23 08:48:52] jeroen <email protected>

The same goes for myself by the way: Now I recall where I read about that hack, it's in this very bug report... :-/

But that hack isn't in repository, Hartmut, is it okay for me to see wether I can add it in the repo?

------------------------------------------------------------------------

[2001-09-23 08:39:11] jeroen <email protected>

I use LaTeX a lot, and of course I know this feature, but that's not the point here!

Please read the report carefully before closing.

Reopening

------------------------------------------------------------------------

[2001-09-22 17:09:48] eschmid <email protected>

This is not a bug. It is a well known feature. If you use LaTeX you should know this.
-Egon

------------------------------------------------------------------------

The remainder of the comments for this report are too long. To view
the rest of the comments, please view the bug report online at
    http://bugs.php.net/?id=7888

Edit this bug report at http://bugs.php.net/?id=7888&edit=1