# AGSHtml... a class to output html for a gsdoc file

richard@brainstorm.co.uk
2001 Free Software Foundation, Inc.
Software documentation for the AGSHtml class
AGSHtml.h
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
decIndent
Description forthcoming.
incIndent
Description forthcoming.
makeAnchor:
r
ofType:
t
name:
n
Calls -makeLink:ofType:isRef: or -makeLink:ofType:inUnit:isRef: to create the first part of an anchor, and fills in the text content of the anchor with n (the specified name). Returns an entire anchor string as a result.
This method is used to create all the anchors in the html output.
makeLink:
r
ofType:
t
inUnit:
u
isRef:
f
Make a link for the element r, with the specified type t, in a particular unit u. Only the start of the html element is returned (<a...>).
If the boolean f is `YES`, then the link is a reference to somewhere, otherwise the link is an anchor for some element being output.
If there is an error, the method returns `nil`.
makeLink:
r
ofType:
t
isRef:
f
Make a link for the element r with the specified type. Only the start of the html element is returned (<a...>). If the boolean f is `YES`, then the link is a reference to somewhere, and the method will return `nil` if the destination is not found in the index. If f is `NO`, then the link is an anchor for some element being output, and the method is guaranteed to succeed and return the link.
outputBlock:
node
to:
buf
inPara:
flag
Outputs zero or more nodes at the same level as long as the nodes are valid %block elements. Returns `nil` or the first node not output. The value of flag is used to control paragraph nesting ... if `YES` we close a paragraph before opening a new one, and open again once the new paragraph closes.
outputDocument:
node
Description forthcoming.
outputIndex:
type
scope:
scope
title:
title
style:
style
target:
target
to:
buf
Description forthcoming.
outputList:
node
to:
buf
Outputs a node as long as it is a valid %list element. Returns next node at this level.
outputNode:
node
to:
buf
Css : TODO print.css
Robots
As a special case, if we have a reference to a function, and we can't find it, we check to see if there is actually a macro of that name and refer to that instead.
outputNodeList:
node
to:
buf
Output all the nodes from this one onwards... try to output as text first, if not possible, call the main method to output each node.
outputText:
node
to:
buf
Outputs zero or more nodes at the same level as long as the nodes are valid %text elements. Returns `nil` or the first node not output.
outputUnit:
node
to:
buf
Description forthcoming.
outputVersion:
prop
to:
buf
Description forthcoming.
protocolRef:
t
Try to make a link to the documentation for the supplied protocol.
setGlobalRefs:
r
Description forthcoming.
setInstanceVariablesAtEnd:
val
Description forthcoming.
setLocalRefs:
r
Description forthcoming.
setProjectRefs:
r
Description forthcoming.
typeRef:
t
Assuming that the supplied string contains type information (as used in a method declaration or type cast), we make an attempt at extracting the basic type, and seeing if we can find a documented declaration for it. If we can, we return a modified version of the string containing a link to the appropriate documentation. Otherwise, we just return the plain type string. In all cases, we strip leading and trailing white space.