[Search for users] [Overall Top Noters] [List of all Conferences] [Download this site]

Conference vaxuum::online_bookbuilding

Title:Online Bookbuilding
Notice:This conference is write-locked: see note 1.3.
Moderator:VAXUUM::UTT
Created:Fri Aug 12 1988
Last Modified:Mon Jul 15 1991
Last Successful Update:Fri Jun 06 1997
Number of topics:440
Total number of notes:2134

8.0. "fonts and tags vs. language conventions" by TLE::BBISHOP () Wed Sep 21 1988 15:32

	VAX languages often present language extensions in a
	second color in their hardcopy form. How is this going to
	be handled for the bookreader? Is a set of tags going to
	be added so that writers can code second-color extensions?
	(Currently, the ADA doctype has such a set, but I don't
	know of a more global set.)

	I've heard that all second-color text is going to appear in 
	boldface type (but haven't yet been able to try out the book-
	reader to see for myself). If this is true, how are words 
	that are already meant to appear in boldface (like reserved
	words in languages like C and Ada) going to be handled in 
	language extensions? 

	And speaking of boldface type, I've recently learned that
	the hardcopy LPAHAND doctype is going to set <newterm> tags
	in boldface type. The special ADA doctype that I use is 
	going to be layered on LPAHAND. I need to go back to italics 
	because of the conflict with boldface Ada reserved words. To do 
	this, I need to do one of the following:

	o  Try to get the global result changed (at least one other
	   language, C, has a similar conflict -- and someone in
	   the DOCUMENT notes file also mentioned a conflict for 
	   another product).

	o  Get the ADA doctype to handle it (but then, what about C
	   and others with this conflict?).

	o  Work around using <emphasis> tags. 

	If I work around on hardcopy with <emphasis> tags, will I be 
	losing something (like special cross-referencing support) with 
	the bookreader? If <newterm> also comes out in boldface
	with the bookreader, what happens if there are <newterm>
	tags in second-color sections (already boldface, if boldface
	is going to be used for second-color language extensions)?

	Thanks, Barbara
	(VAX Ada documentation)	
T.RTitleUserPersonal
Name
DateLines
8.1We have no answer but similar questionsREORG::SEARLEThu Sep 29 1988 09:0818
    I don't have an answer, but we (will soon) face the same problem
    with SQL documentation.  We haven't figured out how to show extensions
    in hardcopy books, let alone online.  We thought an <EXTENSION>...
    <ENDEXTENSION> tag that caused bracketed text to be screened would
    be a nice way to do it, both in hardcopy and online.
    
    To my knowledge, nothing of the sort exists or is planned.  Can
    you tell me a little bit about the ADA doctype and the set of tags
    it uses to handle extensions?  Do you think that it would be a workable
    solution for you if those tags screened text instead of somehow
    denoting second color?
    
    Thanks!
    
    Kirk Searle
    SQL documentation
    
    
8.2ADA doctype and screened textTLE::BBISHOPThu Sep 29 1988 14:1443
    >>Can you tell me a little bit about the ADA doctype and the set of tags
    >>it uses to handle extensions?  
 
    The ADA doctype is layered on LPAHAND and contains mostly
    tag definitions for special tags that format the Language
    Reference Manual (LRM). We need special tags because we include
    the ANSI standard as part of the LRM and need to match the
    ANSI-standard format. 

    Way back when we had DSR and .MEM files as DOCUMENT output,
    and when writers could easily write their own tag
    definitions, etc. we added <EXTENSION> and <END_EXTENSION>
    to the doctype so that I could mark the DEC additions to the
    ANSI standard using different kinds of change bars in review
    drafts (that way, we could have both change bars and extension
    markers. Since we can't do different kinds of change bars or define tags
    easily anymore, the tags are currently no-ops. But my files are coded 
    with them and it would be easy to reactivate them -- or 
    even make them global. It would also be easy for me to change 
    their spellings if need be (e.g. if other languages writers
    wanted different spellings...<ENDEXTENSION> is definitely
    better with respect to DOCUMENT V1.n than <END_EXTENSION>).
    
    >>Do you think that it would be a workable solution for you if 
    >>those tags screened text instead of somehow denoting second color?

    For the online bookreader, I think that screened text (change in
    background shade of gray or color) would make more sense than
    font changes. Some of my extensions are many pages long. I think
    font changes take enough eye adjustment that they would interfere
    with readability, etc. -- in addition to interfering with conventions
    like bolded keywords, etc.

    For hardcopy, I think second color is preferable to screened text.
    I'm sure on-demand printing and the possibility of giving users
    printable files on CDROM will have some affect on second color.
    I hate to open that issue up here -- or give up second color while
    it's still an option. I think second color is optimal for readers,
    even though screened text may be optimal for documentation
    production.

    Barbara

8.3sounds like we agreeREORG::SEARLEFri Sep 30 1988 10:1313
    Thanks for the information!
    
    Sounds like our projects have the same problem.  It also sounds
    like we agree that <EXTENSION> <ENDEXTENSION> tags to bracket text
    the ONLINE doctype will screen is a reasonable solution.

    How <EXTENSION> tags might work for hardcopy is off the subject of this
    conference, but the standard hardcopy doctypes must make some
    accommodation if such a tag works for the ONLINE doctype.  Screening
    makes sense to me for hardcopy because it's something we can produce
    on any PostScript printer.  
    
    Kirk
8.4Screens and text don't mix wellOROGEN::BODGEAndy BodgeFri Sep 30 1988 17:308
    I have a feeling that almost any screening you might do with online
    text would savage the readability.  Either that or the screen would be
    so light that it would hardly show up.  Try laying screens over text in
    your favorite graphics editor -- the letter shapes fall apart quickly.  
    
    With a color system, no problem; but how to support monochrome?
    
    Andy
8.5Still unclear: what plans if any to flag extensions in online books?REORG::SEARLEFri Oct 14 1988 09:2213
    I don't yet understand the answer to the original question in .0:
    
    	VAX languages often present language extensions in a
	second color in their hardcopy form. How is this going to
	be handled for the bookreader? Is a set of tags going to
	be added so that writers can code second-color extensions?

    Can someone edify us on how manuals that flag extensions will be
    accommodated by the ONLINE doctype and the bookreader?  If there
    are no plans to accommodate such manuals, I'm not sure it makes
    sense to put those books online.

    Kirk
8.6VAXUUM::UTTSat Oct 15 1988 16:5920
    Kirk-
    
    I agree that a set of <extension> tags are a good way to handle
    this problem. They can be ignored for hardcopy, if that's
    appropriate, but when we have 2-color printers they'll be
    neededn then, too.
    
    I also agree that screening the text is a bad idea -- the text
    will probably become unreadable.
    
    Font changes also present a problem -- we had a hard enough time
    finding *one* readable  text font! But it's not out of the question:
    It might be possible to find a font that would work. Certainly as
    the font selection and monitor resolution increase, this will become
    a more viable option.
    
    I don't have any answers for you. I think that it's something we'll
    have to think about as we get experience with the bookreader.
    
    Mary