python / cpython

The Python programming language
https://www.python.org
Other
63.39k stars 30.35k forks source link

bad tags in HTML documentation #34975

Closed b7a711ff-d634-47b2-ad1b-41e5ae806c8b closed 23 years ago

b7a711ff-d634-47b2-ad1b-41e5ae806c8b commented 23 years ago
BPO 451556
Nosy @freddrake

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields: ```python assignee = 'https://github.com/freddrake' closed_at = created_at = labels = ['docs'] title = 'bad tags in HTML documentation' updated_at = user = 'https://bugs.python.org/effbot' ``` bugs.python.org fields: ```python activity = actor = 'fdrake' assignee = 'fdrake' closed = True closed_date = None closer = None components = ['Documentation'] creation = creator = 'effbot' dependencies = [] files = [] hgrepos = [] issue_num = 451556 keywords = [] message_count = 4.0 messages = ['5968', '5969', '5970', '5971'] nosy_count = 2.0 nosy_names = ['fdrake', 'effbot'] pr_nums = [] priority = 'normal' resolution = 'fixed' stage = None status = 'closed' superseder = None type = None url = 'https://bugs.python.org/issue451556' versions = [] ```

b7a711ff-d634-47b2-ad1b-41e5ae806c8b commented 23 years ago

just grabbed the HTML versions of the 2.1.1 documentation, and found a couple of rather interesting HTML tags in there:

\<character> \<cdata> \<command> \<tex2html_cross_ref_visible_mark> \<tex2html_ampersand_mark>

can/should this be fixed?

(to find the culprits, run tidy on the files, and look for Error lines. or use grep...)

\</F>

freddrake commented 23 years ago

Logged In: YES user_id=3066

Fixed the first three (\<cdata>, \<character>, and \<command>) by adding them to the table they were missing from in Doc/perl/python.perl revision 1.108.

freddrake commented 23 years ago

Logged In: YES user_id=3066

Fixed the \<tex2html_ampersand_mark> (and protected against the same problem for \<tex2html_percent_mark>) in Doc/perl/SynopsisTable.pm revision 1.8.

The cross_ref_mark will be harder. ;-(

freddrake commented 23 years ago

Logged In: YES user_id=3066

OK, I think the cross_ref_mark problem is a LaTeX2HTML issue; I won't spend any more time looking into it.

Marking this "Fixed" since most of this actually got fixed.