Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/share/doc/gnustep-base-doc/Tools/Reference/
Upload File :
Current File : //usr/share/doc/gnustep-base-doc/Tools/Reference/AGSHtml.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>
AGSHtml... a class to output html for a gsdoc file
</title>
</head>
<body>
<font face="serif">
<a href="BaseTools.html">Up</a>
<br />
<h1><a name="title$AGSHtml">
AGSHtml... a class to output html for a gsdoc file
</a></h1>
<h3>Authors</h3>
<dl>
<dt>Richard Frith-Macdonald (<a href="mailto:richard@brainstorm.co.uk"><code>richard@brainstorm.co.uk</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 2001 Free Software Foundation, Inc.</p>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the AGSHtml class
</a></h1>
<h2><a name="class$AGSHtml">AGSHtml</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>AGSHtml.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="50%" align="left" />
<a href="#_AGSHtml_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-decIndent">-decIndent</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-incIndent">-incIndent</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-makeAnchor$ofType$name$">-makeAnchor:ofType:name:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-makeLink$ofType$inUnit$isRef$">-makeLink:ofType:inUnit:isRef:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-makeLink$ofType$isRef$">-makeLink:ofType:isRef:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputBlock$to$inPara$">-outputBlock:to:inPara:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputDocument$">-outputDocument:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputIndex$scope$title$style$target$to$">-outputIndex:scope:title:style:target:to:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputList$to$">-outputList:to:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputNode$to$">-outputNode:to:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputNodeList$to$">-outputNodeList:to:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputText$to$">-outputText:to:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputUnit$to$">-outputUnit:to:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-outputVersion$to$">-outputVersion:to:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-protocolRef$">-protocolRef:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-setGlobalRefs$">-setGlobalRefs:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-setInstanceVariablesAtEnd$">-setInstanceVariablesAtEnd:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-setLocalRefs$">-setLocalRefs:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-setProjectRefs$">-setProjectRefs:</a></li>
<li><a rel="gsdoc" href="AGSHtml.html#method$AGSHtml-typeRef$">-typeRef:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$AGSHtml-decIndent">decIndent </a></h3>
- (void) <b>decIndent</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-incIndent">incIndent </a></h3>
- (void) <b>incIndent</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-makeAnchor$ofType$name$">makeAnchor: ofType: name: </a></h3>
- (NSString*) <b>makeAnchor:</b> (NSString*)r<b> ofType:</b> (NSString*)t<b> name:</b> (NSString*)n;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#method$AGSHtml-makeLink$ofType$isRef$">
-makeLink:ofType:isRef:
</a>
or
<a rel="gsdoc" href="#method$AGSHtml-makeLink$ofType$inUnit$isRef$">
-makeLink:ofType:inUnit:isRef:
</a>
to create the first part of an anchor, and fills in the
text content of the anchor with <var>n</var> (the
specified name). Returns an entire anchor string
as a result. <br /> This method is used to create all
the anchors in the html output.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-makeLink$ofType$inUnit$isRef$">makeLink: ofType: inUnit: isRef: </a></h3>
- (NSString*) <b>makeLink:</b> (NSString*)r<b> ofType:</b> (NSString*)t<b> inUnit:</b> (NSString*)u<b> isRef:</b> (BOOL)f;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Make a link for the element <var>r</var>, with the
specified type <var>t</var>, in a particular unit
<var>u</var>. Only the start of the html element is
returned (<a...>). <br /> If the boolean
<var>f</var> is <code>YES</code>, then the link is a
reference to somewhere, otherwise the link is an
anchor for some element being output. <br /> If
there is an error, the method returns
<code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-makeLink$ofType$isRef$">makeLink: ofType: isRef: </a></h3>
- (NSString*) <b>makeLink:</b> (NSString*)r<b> ofType:</b> (NSString*)t<b> isRef:</b> (BOOL)f;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Make a link for the element <var>r</var> with the
specified type. Only the start of the html
element is returned (<a...>). If the boolean
<var>f</var> is <code>YES</code>, then the link is a
reference to somewhere, and the method will
return <code>nil</code> if the destination is not
found in the index. If <var>f</var> is
<code>NO</code>, then the link is an anchor for some
element being output, and the method is guaranteed
to succeed and return the link.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputBlock$to$inPara$">outputBlock: to: inPara: </a></h3>
- (GSXMLNode*) <b>outputBlock:</b> (GSXMLNode*)node<b> to:</b> (NSMutableString*)buf<b> inPara:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Outputs zero or more nodes at the same level as
<strong>long</strong> as the nodes are valid
%block elements. Returns <code>nil</code> or the
first <var>node</var> not output. The value of
<var>flag</var> is used to control paragraph nesting
... if <code>YES</code> we close a paragraph before
opening a new one, and open again once the new
paragraph closes.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputDocument$">outputDocument: </a></h3>
- (NSString*) <b>outputDocument:</b> (GSXMLNode*)node;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputIndex$scope$title$style$target$to$">outputIndex: scope: title: style: target: to: </a></h3>
- (void) <b>outputIndex:</b> (NSString*)type<b> scope:</b> (NSString*)scope<b> title:</b> (NSString*)title<b> style:</b> (NSString*)style<b> target:</b> (NSString*)target<b> to:</b> (NSMutableString*)buf;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputList$to$">outputList: to: </a></h3>
- (GSXMLNode*) <b>outputList:</b> (GSXMLNode*)node<b> to:</b> (NSMutableString*)buf;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Outputs a <var>node</var> as <strong>long</strong>
as it is a valid %list element. Returns next
<var>node</var> at this level.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputNode$to$">outputNode: to: </a></h3>
- (void) <b>outputNode:</b> (GSXMLNode*)node<b> to:</b> (NSMutableString*)buf;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Css : TODO print.css <br /> Robots <br /> 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.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputNodeList$to$">outputNodeList: to: </a></h3>
- (void) <b>outputNodeList:</b> (GSXMLNode*)node<b> to:</b> (NSMutableString*)buf;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Output all the nodes from this one onwards... try to
output as text first, if not possible, call the main
method to output each <var>node</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputText$to$">outputText: to: </a></h3>
- (GSXMLNode*) <b>outputText:</b> (GSXMLNode*)node<b> to:</b> (NSMutableString*)buf;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Outputs zero or more nodes at the same level as
<strong>long</strong> as the nodes are valid %text
elements. Returns <code>nil</code> or the first
<var>node</var> not output.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputUnit$to$">outputUnit: to: </a></h3>
- (void) <b>outputUnit:</b> (GSXMLNode*)node<b> to:</b> (NSMutableString*)buf;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-outputVersion$to$">outputVersion: to: </a></h3>
- (void) <b>outputVersion:</b> (NSDictionary*)prop<b> to:</b> (NSMutableString*)buf;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-protocolRef$">protocolRef: </a></h3>
- (NSString*) <b>protocolRef:</b> (NSString*)t;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Try to make a link to the documentation for the
supplied protocol.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-setGlobalRefs$">setGlobalRefs: </a></h3>
- (void) <b>setGlobalRefs:</b> (<a rel="gsdoc" href="AGSIndex.html#class$AGSIndex">AGSIndex</a>*)r;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-setInstanceVariablesAtEnd$">setInstanceVariablesAtEnd: </a></h3>
- (void) <b>setInstanceVariablesAtEnd:</b> (BOOL)val;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-setLocalRefs$">setLocalRefs: </a></h3>
- (void) <b>setLocalRefs:</b> (<a rel="gsdoc" href="AGSIndex.html#class$AGSIndex">AGSIndex</a>*)r;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-setProjectRefs$">setProjectRefs: </a></h3>
- (void) <b>setProjectRefs:</b> (<a rel="gsdoc" href="AGSIndex.html#class$AGSIndex">AGSIndex</a>*)r;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSHtml-typeRef$">typeRef: </a></h3>
- (NSString*) <b>typeRef:</b> (NSString*)t;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
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.
</div>
<hr width="25%" align="left" />
</div>
<a name="_AGSHtml_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for AGSHtml Class</h2>
<h3><a name="ivariable$AGSHtml*base">base</a></h3>
@protected NSString* <b>base</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*category">category</a></h3>
@protected NSString* <b>category</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*chap">chap</a></h3>
@protected unsigned int <b>chap</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*classname">classname</a></h3>
@protected NSString* <b>classname</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*globalRefs">globalRefs</a></h3>
@protected AGSIndex* <b>globalRefs</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*heading">heading</a></h3>
@protected NSString* <b>heading</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*indent">indent</a></h3>
@protected NSMutableString* <b>indent</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*isContentsDoc">isContentsDoc</a></h3>
@protected BOOL <b>isContentsDoc</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*ivarsAtEnd">ivarsAtEnd</a></h3>
@protected BOOL <b>ivarsAtEnd</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*localRefs">localRefs</a></h3>
@protected AGSIndex* <b>localRefs</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*nextFile">nextFile</a></h3>
@protected NSString* <b>nextFile</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*prevFile">prevFile</a></h3>
@protected NSString* <b>prevFile</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*project">project</a></h3>
@protected NSString* <b>project</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*projectRefs">projectRefs</a></h3>
@protected AGSIndex* <b>projectRefs</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*sect">sect</a></h3>
@protected unsigned int <b>sect</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*ssect">ssect</a></h3>
@protected unsigned int <b>ssect</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*sssect">sssect</a></h3>
@protected unsigned int <b>sssect</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*unit">unit</a></h3>
@protected NSString* <b>unit</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$AGSHtml*upFile">upFile</a></h3>
@protected NSString* <b>upFile</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<br />
<a href="BaseTools.html">Up</a>
</font>
</body>
</html>
Server : Apache/2.4.41 (Ubuntu)