2. Plugin Syntax

2. Plugin Syntax
Prev	Home

The syntax to include a Plugin in the wiki is: [{PluginName}]. The following examples explain how to use the two plugins mentionned earlier:

[{ElecturesRecordingsWikiPlugin size='360x270' timestamp='-1' slidenumber='1' type='PAGE_BASED' fileId='9385' electureId='3084' modulId='57' filename='.wikicache/electureslrimage_57_9385_width=360;height=270;index=00001.png'
}]

[{ElecturesLatexMathWikiPlugin

x^2
}]

Instead of creating the entry for the ElecturesRecordingsWikiPlugin yourself, you should use the "Insert-Screenshot-Popup". To do that, edit the wiki page you want to work on, by clicking on the edit icon . Then click on the small icon displayed in the help: A Popup should appear:

Popup to insert a new Wiki screenshot.

Within this popup, first select a semster, then click on the button set semester , then select an institute, chair, etc. At the end you have to select a file. Currently you can only select Lecturnity raw files, camtasia files or presentation documents (i.e. pdf, odp, etc.). If the lecturer used lecturnity to record the lecture and the lecturnity raw files do not appear in the list, please ask the responsible staff to register those files in the Electures-Portal.

When you have chosen your files, you have to specify an interval (from/to) to generate images. Choosing this interval larger (i.e. more pages or a longer time interval) will result in longer processing/load times. Especially for camtasia files this should be chosen as small as possible.

Pay attention to choose the correct image size, the images will be generated with the given size. Later you can only change the html display size in the wiki, not the image size, so make sure you choose an appropriate size.

Clicking on continue should generate the requested images. By clicking on one of the generated images, the appropriate plugin code should be inserted in the wiki. You can then close the popup window.

Electures Plugin Code inserted in the edit field.

You can add two additional parameters width and height , i.e. width='100' height='50' to scale the appearance of the image. This will only scale the generated image in the browser. You should not change any of the other parameters.

2.1. Latex Syntax for the ElecturesLatexMathWikiPlugin

Table 4.1. Latex-Help for the Wiki

Element	Syntax
Operators	+ - * / = < > # ~ ; : , !
Subscripts	_<eqn>
Superscripts	^<eqn>
Fractions	\frac<eqn numerator><eqn denominator>
Square Roots	\sqrt[[<grp>]]<eqn>
Sums	\sum[_<eqn lower limit>][^<eqn upper limit>]
Products	\prod[_<eqn lower limit>][^<eqn upper limit>]
Integrals	\int[_<eqn lower limit>][^<eqn upper limit>] \oint[_<eqn lower limit>][^<eqn upper limit>]
Accents	\acute<eqn> \bar<eqn> \dot<eqn> \ddot<eqn> \grave<eqn> \hat<eqn> \tilde<eqn> \vec<eqn> \widehat<eqn> \widetilde<eqn>
Functions	\arccos \arcsin \arctan \arg \cos \cosh \cot \coth \csc \def \deg \det \dim \exp \gcd \hom \ker \lg \ln \log \sec \sin \sinh \tan \tanh \det[_<eqn limit>] \gcd[_<eqn limit>] \inf[_<eqn limit>] \lim[_<eqn limit>] \liminf[_<eqn limit>] \limsup[_<eqn limit>] \max[_<eqn limit>] \min[_<eqn limit>] \Pr[_<eqn limit>] \sup[_<eqn limit>]
Brackets	\left<char> \right<char> <char> := ( ) [ ] { } \| \\| .(dot) \langle \rangle
Overline/Underline	\overline<eqn> \underline<eqn>
Overbrace/Underbrace	\overbrace<eqn>[^<eqn>] \underbrace<eqn>[_<eqn>]
Stackrel	\stackrel<eqn upper><eqn lower>
Choose/Atop	{ <grp upper> \choose <grp lower>} { <grp upper> \atop <grp lower> }
Additional Space	\quad \qquad \, \: \; \!
Arrays	\begin{array}{<format>} <grp> [& <grp>][\\ <grp>[& <grp>]]\end{array} \begin{eqnarray} <grp> [& <grp>][\\ <grp>[& <grp>]]\end{eqnarray} \array{ <grp> [& <grp>][\\ <grp>[& <grp>]]}*)
Text	\mbox{<text>}
Framebox	\fbox<eqn>
Foreground/Background color	\fgcolor{ rrggbb }<eqn>) \bgcolor{ rrggbb }<eqn>)
Greek symbols	\alpha \beta \gamma \delta \epsilon \varepsilon \zeta \eta \theta \vartheta \iota \kappa \lambda \mu \nu \xi \pi \varpi \rho \varrho \sigma \varsigma \tau \upsilon \phi \varphi \chi \psi \omega \Gamma \Delta \Theta \Lambda \Xi \Pi \Sigma \Upsilon \Phi \Psi \Omega \sum \prod
Binary symbols	\pm \mp \times \div \cdot \cdots \vdots \ldots \ddots \ast \star \dagger \ddagger \amalg \cap \cup \uplus \sqcap \sqcup \vee \wedge \setminus \wr \circ \bullet \diamond \lhd \rhd \unlhd \unrhd \oslash \odot \bigcirc \Box \Diamond \bigtriangleup \bigtriangledown \triangleleft \triangleright \oplus \ominus \otimes
Relationial symbols	\le \leq \ll \subset \subseteq \sqsubset \sqsubseteq \in \vdash \models \ge \geq \gg \supset \supseteq \sqsupset \sqsupseteq \ni \dashv \perp \neq \doteq \approx \cong \equiv \propto \prec \preceq \parallel \sim \simeq \asymp \smile \frown \bowtie \succ \succeq \mid
Negation	\not<eqn>
Arrows	\leftarrow \gets \Leftarrow \rightharpoonup \rightarrow \to\rightharpoondown \Rightarrow \leadsto \leftrightarrow \uparrow \Leftrightarrow \Uparrow \mapsto \downarrow \Downarrow \leftharpoonup \updownarrow \leftharpoondown \Updownarrow \rightleftharpoons \nearrow \longleftarrow \searrow \Longleftarrow \swarrow \longrightarrow \nwarrow \Longrightarrow \longleftrightarrow \Longleftrightarrow \longmapsto \hookrightarrow \hookleftarrow
Other symbols	\aleph \forall \hbar \exists \imath \neg \jmath \flat \ell \natural \wp \sharp \Re \angle \Im \backslash \mho \prime \emptyset \triangle \nabla \clubsuit \diamondsuit \partial \heartsuit \top \spadesuit \bot \Join \infty \Laplace \Fourier

Prev	Up
Chapter 4. Electures-Wiki	Home