PhoenixLecture  2.0.0
Set of tools to make lectures
platexobj_formulae.h
Go to the documentation of this file.
1 /***************************************
2  Auteur : Pierre Aubert
3  Mail : pierre.aubert@lapp.in2p3.fr
4  Licence : CeCILL-C
5 ****************************************/
6 
7 #ifndef __PLATEXOBJ_FORMULAE_H__
8 #define __PLATEXOBJ_FORMULAE_H__
9 
10 #include <string>
11 #include <map>
12 
13 #include "PPath.h"
14 #include "dico_replace_var.h"
15 #include "PLatexObj.h"
16 
18 #define FORMULAE_RECOVER_FILE ".formulae_recover.map"
19 
21 typedef std::map<PString,PString> PMapFormula;
22 
24 struct POutoutMode{
26  PString currentStyle;
28  PMapFormula mapFormula;
30  bool isMathJaxMode;
32  bool isRemoteMathjax;
34  PFullMenu fullMenu;
36  bool isBibliography;
38  bool isBookTheme;
40  PString bookSideBarWidth;
42  PString bookGitlabUrl;
44  bool isEnableBookFeedback;
46  PString bookMail;
48  PString bookMasterProjectUrl;
50  PNestedCall themeCall;
52  PMapKnownVar mapVar;
53 };
54 
55 #include "platexobj_utils.h"
56 
57 void platexobj_loadFormulaeMap(PMapFormula & mapFormula);
58 void platexobj_saveFormulaeMap(const PMapFormula & mapFormula);
59 
60 PString platexobj_htmlStrLatex(POutoutMode & outputMode, const PLatexObj & obj, const PString & latexEnv);
61 PString platexobj_htmlStrInlineMath(POutoutMode & outputMode, const PLatexObj & obj);
62 
63 
64 void platexobj_update_theme(POutoutMode & outputMode, const PPath & themeBaseFile);
65 void platexobj_theme_set_var(POutoutMode & outputMode, const PString & varName, const PString & value);
66 void platexobj_theme_init_var(POutoutMode & outputMode);
67 void platexobj_theme_update_var(POutoutMode & outputMode, const PString & pageLink, const PString & pageTitle,
68  const PString & prevSecLink, const PString & prevSecTitle,
69  const PString & nextSecLink, const PString & nextSecTitle,
70  const PString & parentSecLink, const PString & parentSecTitle,
71  const PPath & currentSourceFile, size_t currentSourceLine);
72 PString platexobj_theme_createPage(POutoutMode & outputMode);
73 
74 #endif
PFullMenu
Full menu of all site.
Definition: PLatexObj.h:168
PLatexObj
Describe a latex object.
Definition: PLatexObj.h:40
PNestedCall
Class used to parse nested call variables.
Definition: PNestedCall.h:36
PPath
Path of a directory or a file.
Definition: PPath.h:17
PString
Extends the std::string.
Definition: PString.h:16
dico_replace_var.h
PMapKnownVar
std::map< PString, PString > PMapKnownVar
Map of known variables.
Definition: dico_replace_var.h:14
PMapFormula
std::map< PString, PString > PMapFormula
Map of the formulae generated by the ptex2html which can be reused by other PLatexObj which have the ...
Definition: platexobj_formulae.h:21
platexobj_theme_init_var
void platexobj_theme_init_var(POutoutMode &outputMode)
Initialise basic variables of POutoutMode.
Definition: platexobj_formulae.cpp:198
platexobj_theme_createPage
PString platexobj_theme_createPage(POutoutMode &outputMode)
Create the page from variables in POutoutMode.
Definition: platexobj_formulae.cpp:266
platexobj_theme_update_var
void platexobj_theme_update_var(POutoutMode &outputMode, const PString &pageLink, const PString &pageTitle, const PString &prevSecLink, const PString &prevSecTitle, const PString &nextSecLink, const PString &nextSecTitle, const PString &parentSecLink, const PString &parentSecTitle, const PPath &currentSourceFile, size_t currentSourceLine)
Update var of POutoutMode for current section.
Definition: platexobj_formulae.cpp:236
platexobj_htmlStrLatex
PString platexobj_htmlStrLatex(POutoutMode &outputMode, const PLatexObj &obj, const PString &latexEnv)
Convert a PLatexObj into a string.
Definition: platexobj_formulae.cpp:144
platexobj_theme_set_var
void platexobj_theme_set_var(POutoutMode &outputMode, const PString &varName, const PString &value)
Set a variable in the map of variable for theme (will take account the IS_XXX_BEGIN accordingly if th...
Definition: platexobj_formulae.cpp:184
platexobj_htmlStrInlineMath
PString platexobj_htmlStrInlineMath(POutoutMode &outputMode, const PLatexObj &obj)
Convert a PLatexObj into a string.
Definition: platexobj_formulae.cpp:160
platexobj_loadFormulaeMap
void platexobj_loadFormulaeMap(PMapFormula &mapFormula)
Load the map file of all the formulae if it exists.
Definition: platexobj_formulae.cpp:20
platexobj_update_theme
void platexobj_update_theme(POutoutMode &outputMode, const PPath &themeBaseFile)
Update the theme of the generated website.
Definition: platexobj_formulae.cpp:175
platexobj_saveFormulaeMap
void platexobj_saveFormulaeMap(const PMapFormula &mapFormula)
Save the map file of the formulae to avoid extra latex call.
Definition: platexobj_formulae.cpp:28
platexobj_utils.h
POutoutMode
Output mode of the html backend.
Definition: pinkscape_slide.h:20
POutoutMode::isEnableBookFeedback
bool isEnableBookFeedback
True to enable feedback in book mode.
Definition: platexobj_formulae.h:44
POutoutMode::isMathJaxMode
bool isMathJaxMode
True to use the MathJax backend, false to use the latex backend.
Definition: platexobj_formulae.h:30
POutoutMode::fullMenu
PFullMenu fullMenu
Full menu for book theme.
Definition: platexobj_formulae.h:34
POutoutMode::bookGitlabUrl
PString bookGitlabUrl
Gitlab url of the current sources of the project.
Definition: platexobj_formulae.h:42
POutoutMode::mapFormula
PMapFormula mapFormula
Map of the formula which are already saved as png files.
Definition: platexobj_formulae.h:28
POutoutMode::mapVar
PMapKnownVar mapVar
Map of output var which are use to fill the output themes.
Definition: platexobj_formulae.h:52
POutoutMode::isBookTheme
bool isBookTheme
True to activate the book theme.
Definition: platexobj_formulae.h:38
POutoutMode::bookMasterProjectUrl
PString bookMasterProjectUrl
Master project url in book mode.
Definition: platexobj_formulae.h:48
POutoutMode::bookMail
PString bookMail
Mail to be used to contact authors in book mode.
Definition: platexobj_formulae.h:46
POutoutMode::isBibliography
bool isBibliography
True if the generated web site has a bibliography, false otherwise.
Definition: platexobj_formulae.h:36
POutoutMode::bookSideBarWidth
PString bookSideBarWidth
Witdh of the book side bar.
Definition: platexobj_formulae.h:40
POutoutMode::isRemoteMathjax
bool isRemoteMathjax
True to activate mathjax but in remote mode (so no need to have mathjax in the generated site)
Definition: platexobj_formulae.h:32
POutoutMode::currentStyle
PString currentStyle
Current style to be used for the generated pages of the site.
Definition: platexobj_formulae.h:26
POutoutMode::themeCall
PNestedCall themeCall
Parsed theme to be used.
Definition: platexobj_formulae.h:50