TTroff()

Troff Class

Syntax

      oTroff:=TTrof():New(<cFile>) --> oTrf

Arguments

<cFile> Name of the Troff file to create

Returns

<oTrf> instance of the TTroff Class

Description

TTroff() is a class that creates the TROFF Documentation Source Code of the same name you pass to the constructor.

The class methods are as follows:

New(<cFile>) Create a new instance of the THtml class Close() Close the created file

WriteTitle(<cTopic>, <cTitle>) Write the file title

WritePar(<cPar>) Write a paragraph

WriteParBold(<cPar>) Same as WritePar(), but the text is bold

WriteLink(<cLink>) Write a link to another topic

WriteText() Writes text without formating

Examples

      PROCEDURE Main()
         LOCAL oTroff

         oTroff := TTroff():New( "tr\harbour.ngi" )
         oTroff:WriteTitle( "Harbour Reference Guide" )
         oTroff:WritePar( "HARBOUR" )
         oTroff:WriteLink( "OverView" )
         oTroff:WriteLink( "License" )

         oTroff:WritePar( "See the Links Above" )
         oTroff:Close()

         RETURN

Compliance

This is a new Harbour Tools class

Platforms

ALL

Seealso

TNortonGuide()

TRtf()

Rtf Class

Syntax

      oNg:=TRtf():New(<cFile>) --> oRtf

Arguments

<cFile> Name of the RTF file to create

Returns

<oRtf> An instance of the TRtf Class

Description

TRtf() is a class that creates the RTF Documentation Source Code of the same name you pass to the constructor.

The class methods are as follows:

New(<cFile>) Create a new instance of the TRtf class

Close() Close the create file

WriteTitle(<cTopic>, <cTitle>) Write the file title

WritePar(<cPar>) Write a paragraph

WriteParBold(<cPar>) Same as WritePar(), but the text is bold

WriteLink(<cLink>) Write a link to another topic

WriteHeader() Write the RTF header

EndPar() Write the end paragraph delimiter

Examples

      PROCEDURE Main()
         LOCAL oRtf

         oRtf := TRtf():New( "rtf\harbour.rtf" )
         oRtf:WriteHeader()
         oRtf:WriteTitle( "Harbour Reference Guide" )
         oRtf:WritePar( "HARBOUR" ):Endpar()
         oRtf:WriteLink( "OverView" )
         oRtf:WriteLink( "License" )

         oRtf:WritePar( "See the Links Above" ):EndPar()
         oRtf:Close()

         RETURN

Compliance

This is a new Harbour Tools class

Platforms

ALL

Seealso

TNortonGuide()

TOs2()

OS/2 Documentation Class

Syntax

      oNg:=TOs2():New(<cFile>) --> oOs2

Arguments

<cFile> Name of the IPF Source file to create

Returns

<oOs2> An instance of the TOs2 Class

Description

TOs2() is a class that creates the OS/2 IPF Source of the same name you pass to the constructor.

The class methods are as follows:

New(<cFile>) Create a new instance of the TOs2 class

Close() Close the created file

WriteTitle(<cTopic>, <cTitle>) Write the file title

WritePar(<cPar>) Write a paragraph

WriteParBold(<cPar>) Same as WritePar(), but the text is bold

WriteLink(<cLink>) Write a link to another topic

ScanLink(<clink>) Scan the aLinkRef array for a valid topic

DosToOs2Text(<cText>) Convert a Dos string to a OS/2 String

Examples

      PROCEDURE Main()
         LOCAL oNg

         oNg := TOs2():New( "ngi\harbour.ngi" )
         oNg:WriteTitle( "Harbour Reference Guide" )
         oNg:WritePar( "HARBOUR" )
         oNg:WriteLink( "OverView" )
         oNg:WriteLink( "License" )

         oNg:WritePar( "See the Links Above" )
         oNg:Close()

         RETURN

Compliance

This is a new Harbour Tools class

Platforms

ALL

Seealso

TNortonGuide()