Tcl Library Source Code

View Ticket
Login
Ticket UUID: 704219
Title: doctools - HTML customization features
Type: RFE Version: None
Submitter: royterry Created on: 2003-03-15 18:44:05
Subsystem: doctools Assigned To: andreas_kupries
Priority: 5 Medium Severity:
Status: Open Last Modified: 2003-03-25 06:52:21
Resolution: Closed By:
    Closed on:
Description:
(Hope I'm not just missing something)

Would like a way to "tune" the output for HTML, such as 
specificy H1 vs. H2 or custom tag for section headers. 
Also the built-in headers like NAME and DESCRIPTION 
should be optional and their text should be settable. For 
example, the user may wish initial caps instead of all 
caps. Fonts? Colors, etc.

Is there a plan for customizability of HTML?

Cheers,
Roy Terry
User Comments: andreas_kupries added on 2003-03-25 06:52:04:
Logged In: YES 
user_id=75003

Currently there is not much. Engines may 
support 'parameters'. The HTML engine supports

meta, header, footer, xref

meta - Insert HTML code immediately before </head>
header - Insert HTML immediately after <body>
footer - See header, before </body>
xref - cross reference information

meta for example can be used inject a CSS reference into the 
generated HTML. I do this for the ActiveTcl docs to get the 
AS specific colors, fonts, etc.

The tags themselves cannot be changed. For this you have to 
take the existing fmt.html engine and modify it to your liking.

NAME/DESCRIPTION settable could be done through 
parameters. Optional ... More difficult.

I had talked with Joe English about this too. Parameters was 
one possible approach and so far the ine easiest for me to 
implement. Other approaches are to write an egnine in some 
OO system and then generate customized engines by 
derivation or aggregation. [incr Tcl] for example is more 
geared towards inheritance, and SNIT better if you use 
aggregation (wrapping + delegation).

Given the above this is at least partially out of the scope of 
doctools. The engines which are present are useable, and 
also examples for people wishing to write their own engines, 
or wishing to customize the existing one more heavily.