Class TTexDocGenerator
Unit
PasDoc_GenLatex
Declaration
type TTexDocGenerator = class(TDocGenerator)
Description
generates latex documentation
Extends TDocGenerator and overwrites many of its methods to generate output in LaTex format.
Hierarchy
Overview
Methods
Properties
 |
property Latex2rtf: boolean read FLatex2rtf write FLatex2rtf default false; |
|
property LatexHead: TStrings read FLatexHead write SetLatexHead; |
Description
Methods
 |
function ConvertString(const s: string): string; override; |
|
|
|
function ConvertChar(c: char): String; override; |
|
Called by ConvertString to convert a character. Will convert special characters to their html escape sequence -> test
|
|
procedure WriteUnit(const HL: integer; const U: TPasUnit); override; |
|
|
|
function LatexString(const S: string): string; override; |
|
|
|
function CodeString(const s: string): string; override; |
|
Makes a String look like a coded String, i.e. '\begin{ttfamily}TheString\end{ttfamily}' in LaTeX. }
|
|
function CreateLink(const Item: TBaseItem): string; override; |
|
Returns a link to an anchor within a document. LaTeX simply concatenates the strings with either a "-" or "." character between them.
|
|
procedure WriteStartOfCode; override; |
|
|
|
procedure WriteEndOfCode; override; |
|
|
|
function Paragraph: string; override; |
|
|
|
function ShortDash: string; override; |
|
|
|
function LineBreak: string; override; |
|
|
|
function URLLink(const URL: string): string; override; |
|
|
|
function FormatKeyWord(AString: string): string; override; |
|
FormatKeyWord is called from within FormatPascalCode to return AString in a bold font.
|
|
function FormatCompilerComment(AString: string): string; override; |
|
FormatCompilerComment is called from within FormatPascalCode to return AString in italics.
|
|
function FormatComment(AString: string): string; override; |
|
FormatComment is called from within FormatPascalCode to return AString in italics.
|
|
function FormatAnchor(const Anchor: string): string; override; |
|
|
|
function MakeItemLink(const Item: TBaseItem; const LinkCaption: string; const LinkContext: TLinkContext): string; override; |
|
|
|
function FormatBold(const Text: string): string; override; |
|
|
|
function FormatItalic(const Text: string): string; override; |
|
|
|
function FormatPreformatted(const Text: string): string; override; |
|
|
|
function FormatImage(FileNames: TStringList): string; override; |
|
|
|
function FormatList(ListData: TListData): string; override; |
|
|
|
function FormatTable(Table: TTableData): string; override; |
|
|
 |
function FormatPascalCode(const Line: string): string; override; |
|
FormatPascalCode is intended to format Line as if it were Object Pascal code in Delphi or Lazarus. However, unlike Lazarus and Delphi, colored text is not used because printing colored text tends to be much more expensive than printing all black text.
|
|
function GetFileExtension: string; override; |
|
Returns Latex file extension ".tex".
|
|
procedure WriteDocumentation; override; |
|
The method that does everything — writes documentation for all units and creates overview files.
|
|
constructor Create(AOwner: TComponent); override; |
|
|
|
destructor Destroy; override; |
|
|
|
function EscapeURL(const AString: string): string; virtual; |
|
|
|
function FormatSection(HL: integer; const Anchor: string; const Caption: string): string; override; |
|
|
Properties
|
property Latex2rtf: boolean read FLatex2rtf write FLatex2rtf default false; |
|
Indicate if the output must be simplified for latex2rtf
|
|
property LatexHead: TStrings read FLatexHead write SetLatexHead; |
|
The strings in LatexHead are inserted directly into the preamble of the LaTeX document. Therefore they must be valid LaTeX code.
|
Generated by PasDoc 0.15.0.
| 
