Up

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

### Authors

Richard Frith-Macdonald (`richard@brainstorm.co.uk`)

Copyright: (C) 2001 Free Software Foundation, Inc.

# Software documentation for the AGSHtml class

## AGSHtml : NSObject

> Declared in:
>   AGSHtml.h

Availability: OpenStep
Description forthcoming.

Instance Variables
Method summary

- -decIndent
- -incIndent
- -makeAnchor:ofType:name:
- -makeLink:ofType:inUnit:isRef:
- -makeLink:ofType:isRef:
- -outputBlock:to:inPara:
- -outputDocument:
- -outputIndex:scope:title:style:target:to:
- -outputList:to:
- -outputNode:to:
- -outputNodeList:to:
- -outputText:to:
- -outputUnit:to:
- -outputVersion:to:
- -protocolRef:
- -setGlobalRefs:
- -setInstanceVariablesAtEnd:
- -setLocalRefs:
- -setProjectRefs:
- -typeRef:

### decIndent

- (void) decIndent;
Availability: OpenStep
Description forthcoming.

### incIndent

- (void) incIndent;
Availability: OpenStep
Description forthcoming.

### makeAnchor: ofType: name:

- (NSString*) makeAnchor: (NSString*)r ofType: (NSString*)t name: (NSString*)n;
Availability: OpenStep
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: ofType: inUnit: isRef:

- (NSString*) makeLink: (NSString*)r ofType: (NSString*)t inUnit: (NSString*)u isRef: (BOOL)f;
Availability: OpenStep
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: ofType: isRef:

- (NSString*) makeLink: (NSString*)r ofType: (NSString*)t isRef: (BOOL)f;
Availability: OpenStep
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: to: inPara:

- (GSXMLNode*) outputBlock: (GSXMLNode*)node to: (NSMutableString*)buf inPara: (BOOL)flag;
Availability: OpenStep
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:

- (NSString*) outputDocument: (GSXMLNode*)node;
Availability: OpenStep
Description forthcoming.

### outputIndex: scope: title: style: target: to:

- (void) outputIndex: (NSString*)type scope: (NSString*)scope title: (NSString*)title style: (NSString*)style target: (NSString*)target to: (NSMutableString*)buf;
Availability: OpenStep
Description forthcoming.

### outputList: to:

- (GSXMLNode*) outputList: (GSXMLNode*)node to: (NSMutableString*)buf;
Availability: OpenStep
Outputs a node as long as it is a valid %list element. Returns next node at this level.

### outputNode: to:

- (void) outputNode: (GSXMLNode*)node to: (NSMutableString*)buf;
Availability: OpenStep
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: to:

- (void) outputNodeList: (GSXMLNode*)node to: (NSMutableString*)buf;
Availability: OpenStep
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: to:

- (GSXMLNode*) outputText: (GSXMLNode*)node to: (NSMutableString*)buf;
Availability: OpenStep
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: to:

- (void) outputUnit: (GSXMLNode*)node to: (NSMutableString*)buf;
Availability: OpenStep
Description forthcoming.

### outputVersion: to:

- (void) outputVersion: (NSDictionary*)prop to: (NSMutableString*)buf;
Availability: OpenStep
Description forthcoming.

### protocolRef:

- (NSString*) protocolRef: (NSString*)t;
Availability: OpenStep
Try to make a link to the documentation for the supplied protocol.

### setGlobalRefs:

- (void) setGlobalRefs: (AGSIndex*)r;
Availability: OpenStep
Description forthcoming.

### setInstanceVariablesAtEnd:

- (void) setInstanceVariablesAtEnd: (BOOL)val;
Availability: OpenStep
Description forthcoming.

### setLocalRefs:

- (void) setLocalRefs: (AGSIndex*)r;
Availability: OpenStep
Description forthcoming.

### setProjectRefs:

- (void) setProjectRefs: (AGSIndex*)r;
Availability: OpenStep
Description forthcoming.

### typeRef:

- (NSString*) typeRef: (NSString*)t;
Availability: OpenStep
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.

## Instance Variables for AGSHtml Class

### base

@protected NSString* base;
Availability: OpenStep
Description forthcoming.

### category

@protected NSString* category;
Availability: OpenStep
Description forthcoming.

### chap

@protected unsigned int chap;
Availability: OpenStep
Description forthcoming.

### classname

@protected NSString* classname;
Availability: OpenStep
Description forthcoming.

### globalRefs

@protected AGSIndex* globalRefs;
Availability: OpenStep
Description forthcoming.

### heading

@protected NSString* heading;
Availability: OpenStep
Description forthcoming.

### indent

@protected NSMutableString* indent;
Availability: OpenStep
Description forthcoming.

### isContentsDoc

@protected BOOL isContentsDoc;
Availability: OpenStep
Description forthcoming.

### ivarsAtEnd

@protected BOOL ivarsAtEnd;
Availability: OpenStep
Description forthcoming.

### localRefs

@protected AGSIndex* localRefs;
Availability: OpenStep
Description forthcoming.

### nextFile

@protected NSString* nextFile;
Availability: OpenStep
Description forthcoming.

### prevFile

@protected NSString* prevFile;
Availability: OpenStep
Description forthcoming.

### project

@protected NSString* project;
Availability: OpenStep
Description forthcoming.

### projectRefs

@protected AGSIndex* projectRefs;
Availability: OpenStep
Description forthcoming.

### sect

@protected unsigned int sect;
Availability: OpenStep
Description forthcoming.

### ssect

@protected unsigned int ssect;
Availability: OpenStep
Description forthcoming.

### sssect

@protected unsigned int sssect;
Availability: OpenStep
Description forthcoming.

### unit

@protected NSString* unit;
Availability: OpenStep
Description forthcoming.

### upFile

@protected NSString* upFile;
Availability: OpenStep
Description forthcoming.

Up