File: pear-manual.php

Source Location: /pearweb_manual-1.2.3/include/pear-manual.php

Classes:

Page Details:

Filesource: Source Code for this file

Includes:

require_once('site.php') [line 21]

getBugReportLink [line 356]

string getBugReportLink(
string $package_name)

Returns the URI to report a bug for the package

Return: URI

Parameters

string

$package_name

Package name, may be NULL for documentation bugs

[ Top ]

getComments [line 372]

string getComments(
string $uri)

Generates and returns the notes comments HTML.

Return: HTML

Parameters

string

$uri

Manual page id

[ Top ]

getManualHeaderNavLinks [line 475]

string getManualHeaderNavLinks(
)

Creates HTML <link rel..> tags that are used by user agents that support it.

Return: HTML code that should be included in the HTML <head> tag.

[ Top ]

manualFooter [line 453]

void manualFooter(
string $id, [string $title = ''])

Display html footer and closing html tag

Parameters

string	$id	ID of docbook chunk (manual page id)
string	$title	Manual page title

[ Top ]

manualHeader [line 423]

void manualHeader(
string $id, [string $title = ''], [string $extraHeaders = null])

Displays HTML headers suitable to display a manual page.

Parameters

string	$id	ID of the docbook chunk (manual page id)
string	$title	Manual page title
string	$extraHeaders	Additional HTML header tags

[ Top ]

navigationBar [line 203]

void navigationBar(
 $id,  $title,  $loc)

Parameters

	$id
	$title
	$loc

[ Top ]

navigationSidebar [line 94]

void navigationSidebar(
 $id, [ $this = ''])

Parameters

	$id
	$this

[ Top ]

sendManualHeaders [line 403]

void sendManualHeaders(
string $charset, string $lang)

Sends HTTP headers for the manual.

Parameters

string	$charset	Charset (encoding) to send
string	$lang	2-letter language code

[ Top ]

setupNavigation [line 46]

void setupNavigation(
array $data)

Fills global variables with navigational links.

Parameters

array

$data

Array containing home, next, prev, up and toc keys.

[ Top ]

wordWrapTitle [line 58]

void wordWrapTitle(
 $title, [ $indent = false])

Parameters

	$title
	$indent

[ Top ]