platexobj_html.h File Reference

#include "platexobj_formulae.h"

Include dependency graph for platexobj_html.h:

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

Go to the source code of this file.

Functions
PString	getHtmlFooter ()
PString	getHtmlHeader (const PString &title, bool useMathJax, bool useRemoteMathjax, const PString &currentStyle)
	Get the html header. More...
PString	platexobj_createLabelSearchLink (const PString &labelName)
	Create the link to the label of the current PLatexObj if it exist. More...
PString	platexobj_createTitle (const PLatexObj &obj, const PString &baliseName, const PString &cssClassName, const PString objTitle, const PString &prefixTitle, bool addLinkLabel)
	Create a title. More...
bool	platexobj_html (POutoutMode &outputMode, const PLatexObj &obj, bool isBibliography=false, const PString &baseInstallPrefix="")
PString	platexobj_htmlMainTitle (const PString &title, const PString &hLevel, const PString &cssClassName)
PString	platexobj_htmlStr (POutoutMode &outputMode, const PLatexObj &obj, bool isBibliography=false, bool allowText=true)
PString	platexobj_htmlStr (POutoutMode &outputMode, const PVecLatexObj &vecObj, bool isBibliography=false, bool allowText=true)
bool	platexobj_htmlStrBase (PString &body, POutoutMode &outputMode, const PLatexObj &obj, bool isBibliography, bool allowText)
PString	platexobj_htmlStrGetEnv (const PLatexObj &obj)
	Convert a PLatexObj into a string. More...
PString	platexobj_htmlStrRef (const PLatexObj &obj)
	Convert a PLatexObj into a string. More...
PString	platexobj_htmlStrRendezVous (const PLatexObj &obj)
	Convert a rendez-vous into a html string. More...
PString	platexobj_htmlStrText (const PLatexObj &obj)
	Convert a PLatexObj into a string. More...
PString	platexobj_htmlStrTextBf (const PLatexObj &obj)
	Convert a PLatexObj into a string. More...
PString	platexobj_htmlStrTextDebug (const PLatexObj &obj)
	Convert a PLatexObj into a string. More...
PString	platexobj_htmlStrTextIt (const PLatexObj &obj)
	Convert a PLatexObj into a string. More...
PString	platexobj_htmlStrUrl (const PLatexObj &obj)
	Convert a PLatexObj into a string. More...
PString	vecMenuToHtml (const PVecMenu &vecMenu)
	Convert the vector of menu into a html string. More...
PString	vecNumberToString (const std::vector< long unsigned int > &vecNb)
	Convert a vector of numbers into a string. More...

Function Documentation

getHtmlFooter()

PString getHtmlFooter

(

)

Referenced by createOutlineHtml(), pbiblio_entryPage(), and pbiblio_html().

Here is the caller graph for this function:

getHtmlHeader()

PString getHtmlHeader	(	const PString &	title,
		bool	useMathJax,
		bool	useRemoteMathjax,
		const PString &	currentStyle
	)

Get the html header.

Parameters

title	: page title
useMathJax	: true to use MathJax, false otherwise
useRemoteMathjax	: true if we use remote mathjax
currentStyle	: current style to be used

Returns

output string

Definition at line 671 of file platexobj_html.cpp.

Referenced by createOutlineHtml(), pbiblio_entryPage(), and pbiblio_html().

Here is the caller graph for this function:

platexobj_createLabelSearchLink()

PString platexobj_createLabelSearchLink

(

const PString &

labelName

)

Create the link to the label of the current PLatexObj if it exist.

Parameters

labelName

: name of the label to be used

Returns

html link to search the label or empty string if there is no label

Definition at line 25 of file platexobj_html.cpp.

                                                                  {
        if(labelName == ""){return "";}
        PString body("<span class=\"redirectIcon\"><a href=\"redirect.html?label="+labelName+"\"><img src=\"images/iconlink_32.png\"></a></span>");
        
        return body;
}

Referenced by platexobj_createTitle(), platexobj_htmlStrAllPart(), platexobj_htmlStrBasicEnv(), platexobj_htmlStrCallDot(), platexobj_htmlStrCaption(), platexobj_htmlStrExtraEnvironement(), platexobj_htmlStrExtraFunction(), platexobj_htmlStrExtraParser(), platexobj_htmlStrImage(), platexobj_htmlStrSvgToPng(), platexobj_htmlStrTabular(), platexobj_htmlStrTimetable(), platexobj_htmlStrTimetableWeek(), and platexobj_textExtraFunction().

Here is the caller graph for this function:

platexobj_createTitle()

PString platexobj_createTitle	(	const PLatexObj &	obj,
		const PString &	baliseName,
		const PString &	cssClassName,
		const PString	objTitle,
		const PString &	prefixTitle,
		bool	addLinkLabel
	)

Create a title.

Parameters

obj	: PLatexObj to be saved
baliseName	: name of the title balise
cssClassName	: css class to be used
objTitle	: title to be printed
prefixTitle	: prefix of the title (Part or Chapter)
addLinkLabel	: true to add the label link in the title

Definition at line 40 of file platexobj_html.cpp.

{
        PString body("");
        body += "\t\t<"+baliseName+" id=\""+valueToString(obj.getId())+"\" class=\""+cssClassName+"\">";
        if(prefixTitle != ""){
                body += prefixTitle + " ";
        }
        body += vecNumberToString(obj.getVecSecNumber());
        
        body += " : "+objTitle;
        if(addLinkLabel){
                body += platexobj_createLabelSearchLink(obj.getLabelName());
        }
        body += "</"+baliseName+">\n";
        return body;
}

References PLatexObj::getId(), PLatexObj::getLabelName(), PLatexObj::getVecSecNumber(), platexobj_createLabelSearchLink(), valueToString(), and vecNumberToString().

Referenced by platexobj_book_createPage().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_html()

bool platexobj_html	(	POutoutMode &	outputMode,
		const PLatexObj &	obj,
		bool	isBibliography = false,
		const PString &	baseInstallPrefix = ""
	)

Referenced by processAllFile().

Here is the caller graph for this function:

platexobj_htmlMainTitle()

PString platexobj_htmlMainTitle	(	const PString &	title,
		const PString &	hLevel,
		const PString &	cssClassName
	)

Referenced by platexobj_bookIndexHtml().

Here is the caller graph for this function:

platexobj_htmlStr() [1/2]

PString platexobj_htmlStr	(	POutoutMode &	outputMode,
		const PLatexObj &	obj,
		bool	isBibliography = false,
		bool	allowText = true
	)

Referenced by getSectionTitle(), platexobj_htmlStrBasicEnv(), platexobj_htmlStrCaption(), platexobj_htmlStrColumns(), platexobj_htmlStrDetail(), platexobj_htmlStrExtraEnvironement(), platexobj_htmlStrExtraFunction(), platexobj_htmlStrHref(), platexobj_htmlStrQuote(), platexobj_htmlStrSummary(), platexobj_htmlStrTabCell(), platexobj_htmlStrTabRow(), platexobj_htmlStrTabular(), platexobj_htmlStrTextFootnote(), platexobj_htmlStrTimetable(), platexobj_htmlStrTimetableBlock(), platexobj_htmlStrTimetableTimeRow(), platexobj_htmlStrTimetableWeek(), and platexobj_htmlStrWip().

Here is the caller graph for this function:

platexobj_htmlStr() [2/2]

PString platexobj_htmlStr	(	POutoutMode &	outputMode,
		const PVecLatexObj &	vecObj,
		bool	isBibliography = false,
		bool	allowText = true
	)

platexobj_htmlStrBase()

bool platexobj_htmlStrBase	(	PString &	body,
		POutoutMode &	outputMode,
		const PLatexObj &	obj,
		bool	isBibliography,
		bool	allowText
	)

Referenced by platexobj_bookHtml().

Here is the caller graph for this function:

platexobj_htmlStrGetEnv()

PString platexobj_htmlStrGetEnv

(

const PLatexObj &

obj

)

Convert a PLatexObj into a string.

Parameters

obj	: PLatexObj to be converted into a string

Returns

output string which contains the PLatexObj

Definition at line 88 of file platexobj_html.cpp.

                                                      {
        PString body("");
        body += phoenix_getenv(obj.getName());
        return body;
}

References PLatexObj::getName(), and phoenix_getenv().

Referenced by platexobj_text().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_htmlStrRef()

PString platexobj_htmlStrRef

(

const PLatexObj &

obj

)

Convert a PLatexObj into a string.

Parameters

obj	: PLatexObj to be converted into a string

Returns

output string which contains the PLatexObj

Definition at line 108 of file platexobj_html.cpp.

                                                   {
        PString body("");
//      const PString & linkObj = obj.getLink();
//      replaceCharInStr(getSecNumberFromFileName(linkObj), '-', '.')
        body += "<a href=\"" + obj.getLink() + "\">";
        if(obj.getVecContent().size() != 0lu){
                body += platexobj_text(obj.getVecContent());
        }else{
                PString textLink = obj.getName();
                body += textLink;
        }
        body +=  "</a>";
        return body;
}

References PLatexObj::getLink(), PLatexObj::getName(), PLatexObj::getVecContent(), and platexobj_text().

Referenced by platexobj_rawtext(), and platexobj_text().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_htmlStrRendezVous()

PString platexobj_htmlStrRendezVous

(

const PLatexObj &

obj

)

Convert a rendez-vous into a html string.

Parameters

obj	: PLatexObj to be converted in html

Returns

html string

Definition at line 542 of file platexobj_html.cpp.

                                                          {
        PString body("");
        //We add a block in the timetable table
        body += "<a id=\""+valueToString(obj.getId())+"\" href=\""+obj.getText()+"\"><div class=\"rendezvousStyle\"></div></a>";
        return body;
}

References PLatexObj::getId(), PLatexObj::getText(), and valueToString().

Referenced by platexobj_rawtext().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_htmlStrText()

PString platexobj_htmlStrText

(

const PLatexObj &

obj

)

Convert a PLatexObj into a string.

Parameters

obj	: PLatexObj to be converted into a string

Returns

output string which contains the PLatexObj

Definition at line 62 of file platexobj_html.cpp.

                                                    {
        return convertStrToHtml(obj.getText());
}

References convertStrToHtml(), and PLatexObj::getText().

Referenced by platexobj_rawtext(), and platexobj_text().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_htmlStrTextBf()

PString platexobj_htmlStrTextBf

(

const PLatexObj &

obj

)

Convert a PLatexObj into a string.

Parameters

obj	: PLatexObj to be converted into a string

Returns

output string which contains the PLatexObj

Definition at line 184 of file platexobj_html.cpp.

                                                      {
        PString body("");
        body += "<b>" + obj.getName() + "</b>";
        return body;
}

References PLatexObj::getName().

Referenced by platexobj_text().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_htmlStrTextDebug()

PString platexobj_htmlStrTextDebug

(

const PLatexObj &

obj

)

Convert a PLatexObj into a string.

Parameters

obj	: PLatexObj to be converted into a string

Returns

output string which contains the PLatexObj

Definition at line 204 of file platexobj_html.cpp.

                                                         {
        PString body("");
        body += "<span class=\"debug\" id=\""+valueToString(obj.getId())+"\">" + obj.getName() + "</span>";
        return body;
}

References PLatexObj::getId(), PLatexObj::getName(), and valueToString().

Referenced by platexobj_rawtext(), and platexobj_text().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_htmlStrTextIt()

PString platexobj_htmlStrTextIt

(

const PLatexObj &

obj

)

Convert a PLatexObj into a string.

Parameters

obj	: PLatexObj to be converted into a string

Returns

output string which contains the PLatexObj

Definition at line 194 of file platexobj_html.cpp.

                                                      {
        PString body("");
        body += "<em id=\""+valueToString(obj.getId())+"\">" + obj.getName() + "</em>";
        return body;
}

References PLatexObj::getId(), PLatexObj::getName(), and valueToString().

Referenced by platexobj_text().

Here is the call graph for this function:

Here is the caller graph for this function:

platexobj_htmlStrUrl()

PString platexobj_htmlStrUrl

(

const PLatexObj &

obj

)

Convert a PLatexObj into a string.

Parameters

obj	: PLatexObj to be converted into a string

Returns

output string which contains the PLatexObj

Definition at line 78 of file platexobj_html.cpp.

                                                   {
        PString body("");
        body += "<a id=\""+valueToString(obj.getId())+"\" href=\"" + obj.getName() + "\">" + obj.getName() + "</a>";
        return body;
}

References PLatexObj::getId(), PLatexObj::getName(), and valueToString().

Referenced by platexobj_rawtext(), and platexobj_text().

Here is the call graph for this function:

Here is the caller graph for this function:

vecMenuToHtml()

PString vecMenuToHtml

(

const PVecMenu &

vecMenu

)

Convert the vector of menu into a html string.

Parameters

vecMenu

: vector to be converted

Returns

output string

Definition at line 648 of file platexobj_html.cpp.

                                               {
        if(vecMenu.size() == 0lu){return "";}
        PString body("");
        body += "\t\t<ul class=\"sommaire\">\n";
        for(PVecMenu::const_iterator it(vecMenu.begin()); it != vecMenu.end(); ++it){
                body += "\t\t\t<li><a href=\""+it->getLink()+"\">"+getSecNumberFromFileName(it->getLink()).replace("-", ".")+") ";
                
//              body += convertStrToHtml(it->getText());
                body += it->getText();
                
                body += "</a></li>\n";
        }
        body += "\t\t</ul>\n";
        return body;
}

References getSecNumberFromFileName(), and PString::replace().

Here is the call graph for this function:

vecNumberToString()

PString vecNumberToString

(

const std::vector< long unsigned int > &

vecNb

)

Convert a vector of numbers into a string.

Parameters

vecNb

: vector of numbers to be converted

Returns

output string

Definition at line 631 of file platexobj_html.cpp.

                                                                     {
        if(vecNb.size() == 0lu){return "";}
        PString body("");
        std::vector<long unsigned int>::const_iterator it(vecNb.begin());
        body += valueToString(*it);
        ++it;
        while(it != vecNb.end()){
                body += "." + valueToString(*it);
                ++it;
        }
        return body;
}

References valueToString().

Referenced by createOutlineHtmlStr(), platexobj_createTitle(), platexobj_toMenuAll(), and updateMapLabel().

Here is the call graph for this function:

Here is the caller graph for this function: