Re: documentation.html patch

Re: documentation.html patch

[Phil Edwards]

On Tue, Aug 13, 2002 at 05:00:08PM +0100, Jonathan Wakely wrote:
> The documentation.html page has "<sstream>" which should use HTML
> entities, because otherwise the heading is
> "What is this /stringstreams thing?"
> 
> Which made me think "Yes, what *is* this slash-stringstreams thing?"

Thanks, good catch.  This is in; I spotted some other goofs while making
the change.  Looks like the HTML text was copied from the /rendered/
version of the various howto's.  All fixed AFAIK now.


2002-08-13  Jonathan Wakely  <jw@kayari.org>
            Phil Edwards  <pme@gcc.gnu.org>

	* docs/html/documentation.html:  Use HTML entities for punctuation.


Index: docs/html/documentation.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/documentation.html,v
retrieving revision 1.17
diff -u -3 -p -r1.17 documentation.html
--- docs/html/documentation.html	24 Jul 2002 07:55:34 -0000	1.17
+++ docs/html/documentation.html	13 Aug 2002 16:24:35 -0000
@@ -91,7 +91,7 @@
          <li>Intro (Chapter 17)
 	 <ul>
          <li><a href="17_intro/howto.html#1">Header files</a>
-         <li><a href="17_intro/howto.html#3">Using <foo> vs <foo.h></a>
+         <li><a href="17_intro/howto.html#3">Using &lt;foo&gt; vs &lt;foo.h&gt;</a>
          <li><a href="17_intro/howto.html#2">Multithreading</a>
          <li><a href="17_intro/howto.html#4">Porting</a>
          <li><a href="17_intro/howto.html#5">Implementation-specific behavior</a>
@@ -149,9 +149,9 @@
          <li><a href="23_containers/howto.html#1">Making code unaware of the container/array difference</a>
          <li><a href="23_containers/howto.html#2">Variable-sized bitmasks</a>
          <li><a href="23_containers/howto.html#3">Containers and multithreading</a>
-         <li><a href="23_containers/howto.html#4">"Hinting" during insertion</a>
+         <li><a href="23_containers/howto.html#4">&quot;Hinting&quot; during insertion</a>
          <li><a href="23_containers/howto.html#5">Bitmasks and string arguments</a>
-         <li><a href="23_containers/howto.html#6">std::list::size() is O(n)!</a>
+         <li><a href="23_containers/howto.html#6"><code>std::list::size()</code> is O(n)!</a>
          <li><a href="23_containers/howto.html#7">Space overhead management for vectors </a>
 	 </ul>
 
@@ -184,7 +184,7 @@
          <li><a href="27_io/howto.html#3">Binary I/O</a>
          <li><a href="27_io/howto.html#6">More on binary I/O</a>
          <li><a href="27_io/howto.html#5">Deriving a stream buffer</a>
-         <li><a href="27_io/howto.html#4">What is this <sstream>/stringstreams thing?</a>
+         <li><a href="27_io/howto.html#4">What is this &lt;sstream&gt;/stringstreams thing?</a>
          <li><a href="27_io/howto.html#7">Pathetic performance? Ditch C.</a>
          <li><a href="27_io/howto.html#8">Threads and I/O</a>
 	 </ul>

Re: documentation.html patch

[Phil Edwards]

On Tue, Aug 13, 2002 at 05:53:18PM +0100, Jonathan Wakely wrote:
> > I was just looking at docs/html/22_locale/messages.html as well, and it needs
> > the following patch to fix the asme problem.
> 
> I missed some other symbols in this file, more <'s and >'s and &'s too.
> This replaces the last patch.
> 
> I can't see any other problems in this file (which probably says more
> about my proofreading than about the file ;)
> 
> 
> 2002-08-13  Jonathan Wakely  <jw@kayari.org>
> 
> 	* docs/html/22_locale/messages.html:  Use HTML entities for punctuation.
> 

This now in, thanks very much!


Phil

-- 
I would therefore like to posit that computing's central challenge, viz. "How
not to make a mess of it," has /not/ been met.
                                                 - Edsger Dijkstra, 1930-2002

Re: HTML docs

[Phil Edwards]

On Thu, Aug 15, 2002 at 11:19:53AM -0700, Benjamin Kosnik wrote:
> 
> Also, can there be an official doxygen release for gcc-3.2.0?

There can.


2002-08-15  Phil Edwards  <pme@gcc.gnu.org>

	* docs/html/documentation.html:  Update doxygen links for 3.2.


Index: docs/html/documentation.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/documentation.html,v
retrieving revision 1.18
diff -u -3 -p -r1.18 documentation.html
--- docs/html/documentation.html	13 Aug 2002 16:26:13 -0000	1.18
+++ docs/html/documentation.html	15 Aug 2002 20:18:32 -0000
@@ -60,7 +60,8 @@
 </p>
 <p>The Source-Level documentation can be viewed online:
    <ul>
-   <li><a href="libstdc++-html-USERS-3.1/index.html">For the 3.1 release</a>
+   <li><a href="libstdc++-html-USERS-3.1/index.html">for the 3.1 release</a>
+   <li><a href="libstdc++-html-USERS-3.2/index.html">for the 3.2 release</a>
    <li><a href="latest-doxygen/index.html">&quot;the latest collection&quot;</a>
        (for the snapshot or later; see the date on the first page)
    </ul>
@@ -76,7 +77,7 @@
 </p>
 <p>
  In addition, an initial set of man pages are also available in the
- same place as the HTML collections. Start with Intro(3).
+ same place as the HTML collections.  Start with Intro(3).
 </p>
 
 

Re: HTML docs

[Phil Edwards]

On Mon, Aug 19, 2002 at 01:06:24PM +0100, Jonathan Wakely wrote:
> 2002-08-19  Jonathan Wakely  <jw@kayari.org>
> 
> 	* docs/html/configopts.html, docs/html/documentation.html,
> 	docs/html/install.html, docs/html/22_locale/codecvt.html,
> 	docs/html/22_locale/ctype.html, docs/html/22_locale/howto.html,
> 	docs/html/22_locale/locale.html,
> 	docs/html/22_locale/messages.html: Conform to HTML 4.01 standard.

This is in now.  I think we're actually moving towards something called
xhtml eventually, so there will probably need to be more changes in the
future by somebody who understands it.


Thanks!
Phil

-- 
I would therefore like to posit that computing's central challenge, viz. "How
not to make a mess of it," has /not/ been met.
                                                 - Edsger Dijkstra, 1930-2002

Re: HTML docs

[Janis Johnson]

On Mon, Aug 19, 2002 at 08:45:28PM -0400, Phil Edwards wrote:
> On Mon, Aug 19, 2002 at 01:06:24PM +0100, Jonathan Wakely wrote:
> > 2002-08-19  Jonathan Wakely  <jw@kayari.org>
> > 
> > 	* docs/html/configopts.html, docs/html/documentation.html,
> > 	docs/html/install.html, docs/html/22_locale/codecvt.html,
> > 	docs/html/22_locale/ctype.html, docs/html/22_locale/howto.html,
> > 	docs/html/22_locale/locale.html,
> > 	docs/html/22_locale/messages.html: Conform to HTML 4.01 standard.
> 
> This is in now.  I think we're actually moving towards something called
> xhtml eventually, so there will probably need to be more changes in the
> future by somebody who understands it.

GCC web pages are expected to comply with XHTML 1.0 Transitional.  Look
for "Changes to the web site" in http://gcc.gnu.org/contribute.html,
which tells how to validate web pages.

Janis