Unit PasDoc_Tipue

Classes, Interfaces, Objects and Records
Types
Constants
Variables

Description

Helper unit for integrating tipue [http://www.tipue.com/] with pasdoc HTML output.

Uses

Overview

Functions and Procedures

function TipueSearchButtonHead: string;
function TipueSearchButton: string;
procedure TipueAddFiles(Units: TPasUnits; const Introduction, Conclusion: TExternalItem; const Head, BodyBegin, BodyEnd: string; const LanguageCode: string; const OutputPath: string);

Description

Functions and Procedures

function TipueSearchButtonHead: string;

Put this in <head> of every page with search button.

function TipueSearchButton: string;

Put this at a place where Tipue button should appear. It will make a form with search button. You will need to use Format to insert the localized word for "Search", e.g.: Format(TipueSearchButton, ['Search']) for English.

procedure TipueAddFiles(Units: TPasUnits; const Introduction, Conclusion: TExternalItem; const Head, BodyBegin, BodyEnd: string; const LanguageCode: string; const OutputPath: string);

Adds some additional files to html documentation, needed for tipue engine.

OutputPath is our output path, where html output must be placed. Must end with PathDelim.

Units must be non-nil. It will be used to generate index data for tipue.


Generated by PasDoc 0.15.0.