WxMaximaManualAnchors.cpp File Reference

The commands and variables wxMaxima's own manual documents. More...

#include "WxMaximaManualAnchors.h"
#include <algorithm>

Include dependency graph for WxMaximaManualAnchors.cpp:

This graph shows which files directly or indirectly include this file:

Functions
const std::vector< wxString > &	WxMaximaManualAnchors::Keywords ()
	Every keyword wxMaxima's own manual has an anchor for.
wxString	WxMaximaManualAnchors::AnchorFor (wxString keyword)
	The anchor in wxMaxima's manual that documents keyword.
bool	WxMaximaManualAnchors::HtmlHasAnchor (const wxString &html, const wxString &anchor)
	Whether the HTML text html contains the anchor anchor.

Detailed Description

The commands and variables wxMaxima's own manual documents.

Function Documentation

AnchorFor()

wxString WxMaximaManualAnchors::AnchorFor

(

wxString

keyword

)

The anchor in wxMaxima's manual that documents keyword.

Empty if wxMaxima's manual doesn't document it. A trailing "(" (as in "wx_matrix(") is ignored, so that the word a user selected can be passed as it is.

HtmlHasAnchor()

bool WxMaximaManualAnchors::HtmlHasAnchor	(	const wxString &	html,
		const wxString &	anchor
	)

Whether the HTML text html contains the anchor anchor.

A translated manual that was converted to HTML before an anchor was added to the manual lacks it; the help browser then has to be pointed at a manual that has it.