Public Types
using	HelpFileAnchors = std::unordered_map< wxString, wxString, wxStringHash >

Public Member Functions
	MaximaManual (Configuration *configuration)

HelpFileAnchors	GetHelpfileAnchors ()

void	FindMaximaHtmlDir (const wxString &docDir)

wxString	GetHelpfileAnchorName (const wxString &keyword)

wxString	GetHelpfileUrl_Singlepage (const wxString &keyword)

wxString	GetHelpfileUrl_FilePerChapter (const wxString &keyword)

wxString	GetHelpfileURL (const wxString &keyword)

void	LoadHelpFileAnchors (const wxString &docdir, const wxString &maximaVersion)
	Search maxima's help file for command and variable names.

void	CompileHelpFileAnchors (const stop_token &stopToken, const wxString &maximaHtmlDir, const wxString &maximaShareDir, const wxString &maximaVersion, const wxString &saveName)
	Collect all keyword anchors in the help file.

bool	LoadManualAnchorsFromCache ()
	Load the result from the last CompileHelpFileAnchors from the disk cache.

bool	LoadManualAnchorsFromXML (const wxXmlDocument &xmlDocument, bool checkManualVersion=true)
	Load the help file anchors from an wxXmlDocument.

bool	LoadBuiltInManualAnchors ()
	Load the help file anchors from the built-in list.

void	SaveManualAnchorsToCache (const wxString &maximaHtmlDir, const wxString &maximaVersion, const wxString &saveName)
	Save the list of help file anchors to the cache.

Member Function Documentation

◆ CompileHelpFileAnchors()

void MaximaManual::CompileHelpFileAnchors	(	const stop_token &	stopToken,
		const wxString &	maximaHtmlDir,
		const wxString &	maximaShareDir,
		const wxString &	maximaVersion,
		const wxString &	saveName
	)

Collect all keyword anchors in the help file.

Runs in a background thread, so it reads nothing but its arguments and the anchor maps (under m_helpFileAnchorsLock).

The documentation for this class was generated from the following files: