WxMaximaManualAnchors.h File Reference

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

#include <wx/string.h>
#include <vector>

Include dependency graph for WxMaximaManualAnchors.h:

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

Go to the source code of 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.

Context-sensitive help used to know only Maxima's manual, whose index wxMaxima reads from the manual itself (see MaximaManual). The commands wxMaxima adds to Maxima - wx_matrix(), table_form(), wxstatusbar(), the wx... variables - are documented in wxMaxima's own manual (info/wxmaxima.md) instead, so they got no "Help on" entry at all.

wxMaxima's manual has no index to read: it is prose, and its headings, and therefore the ids pandoc derives from them, are translated. So each of these keywords has an explicit <div id="keyword"></div> in front of the paragraph that documents it, in the English manual and in every translated one, and this file lists them. test_WxMaximaManualAnchors checks that the two stay in step.

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.