This is the mail archive of the libstdc++@sourceware.cygnus.com mailing list for the libstdc++ project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

RE: more on the FAQ tip



+ hmm. Maybe we should (eventually) have some parts of the FAQ that have
+ more of a HOWTO quality, like:
+ 
+ - coding for MFC/libstdc++ string classes
+ - ditto for iostreams and filebufs
+ - how to use iostreams with a persistant object framework
+ - what flags to use for optimizing size and speed
+ 
+ etc etc etc. I think this would be valuable information/documentation.
+ 
+ Just a random thought.


I like Benjamin's random thought.  I've been thinking of a set of HTML files
arranged like this (which would then generate text, etc):

	- the FAQ itself (we'll come back to this)
	- HOWTOs and notes on library chapter 17
	- HOWTOs and notes on library chapter 18
	  ...
	- HOWTOs and notes on library chapter 27

Right now the FAQ follows the look'n'feel of the EGCS FAQ, e.g., all one
HTML document.  I thought that the HOWTO/notes should be broken out into
their own documents, just to prevent a single massive file.  That section of
the FAQ can contain links to the other documents, rather than internal
jumps.

I've started a small list of entries for the HOWTO on the string chapter.
This MFC note, the "how do I make a case-insensitive string class" from the
GotW, idioms like "how do I convert a string to {upper,lower}case," etc.
Any ideas?


I've sent the first hack at a FAQ to Gabriel for checkin.  Note that the
docs/faq/html/index.html with a revision of 1.1 was something of a
placeholder containing the questions.  The HTML I wrote was handwritten, not
generated by a WYSI!(WYG) editor, so I hope it's readable by humans.  A
couple of the questions I haven't written yet, but they have [bracketed
answer notes] indicating what I'm going to write.

There are a few HTML comments in the doc, in places where I'm not certain
that I have the Right Thing in place.  I'm sure that a few of the answers
are factually wrong, so please point them out to me once the new revision
appears.


Phil
(still having to specify the repository root with each checkout, contrary to
what the V3 homepage seems to say)


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]