NMEPluginWiki.h File Reference

NME optional plugin for wiki extensions. More...

#include "NME.h"

Go to the source code of this file.

Defines
#define	NMEPluginKeywordsEntry
	NMEPlugin entry for table of plugins.
#define	NMEPluginExecuteEntry
	NMEPlugin entry for table of plugins.
#define	NMEMonthNameEn   "january,february,march,april,may,june,july,august,september,october,november,december,"
#define	NMEMonthNameFr   "janvier,f\xc3\xa9vrier,mars,avril,mai,juin,juillet,ao\xc3\xbbt,septembre,octobre,novembre,d\xc3\xa9""cembre,"
#define	NMEMonthNameSp   "enero,febrero,marzo,abril,mayo,junio,julio,agosto,septiembre,octubre,noviembre,diciembre,"
#define	NMEMonthNameIt   "gennaio,febbraio,marzo,aprile,maggio,giugno,luglio,agosto,settembre,ottobre,novembre,dicembre,"
#define	NMEMonthNameDe   "januar,februar,m\xc3\xa4rz,april,mai,juni,juli,august,september,oktober,november,dezember,"
#define	NMEPluginDateEntry(months)
	NMEPlugin entry for table of plugins.
Functions
NMEErr	NMEPluginKeywords (NMEConstText name, NMEInt nameLen, NMEConstText data, NMEInt dataLen, NMEContext *context, void *userData)
	Plugin implementation for keywords (plugin's data: comma-separated keywords); write each keyword on a separate line (should be used with NMEOutputFormatNull)
NMEErr	NMEPluginExecute (NMEConstText name, NMEInt nameLen, NMEConstText data, NMEInt dataLen, NMEContext *context, void *userData)
	Plugin implementation for execute (plugin's data: method name and arguments); write data without leading and trailing spaces on a separate line (should be used with NMEOutputFormatNull)
NMEErr	NMEPluginDate (NMEConstText name, NMEInt nameLen, NMEConstText data, NMEInt dataLen, NMEContext *context, void *userData)
	Plugin implementation for date (plugin's data: date and time); write each date on a separate line (should be used with NMEOutputFormatNull)

---

Detailed Description

NME optional plugin for wiki extensions.

Author:

Yves Piguet.

Copyright:

2009-2013, Yves Piguet.

Definition in file NMEPluginWiki.h.

---

Define Documentation

#define NMEPluginDateEntry

(

months

)

Value:

{"date", kNMEPluginOptBetweenPar, \
        NMEPluginDate, months}

NMEPlugin entry for table of plugins.

Definition at line 121 of file NMEPluginWiki.h.

#define NMEPluginExecuteEntry

Value:

{"execute", kNMEPluginOptBetweenPar, \
        NMEPluginExecute, NULL}

NMEPlugin entry for table of plugins.

Definition at line 84 of file NMEPluginWiki.h.

#define NMEPluginKeywordsEntry

Value:

{"keywords", kNMEPluginOptBetweenPar, \
        NMEPluginKeywords, NULL}

NMEPlugin entry for table of plugins.

Definition at line 61 of file NMEPluginWiki.h.

---

Function Documentation

NMEErr NMEPluginDate	(	NMEConstText	name,
		NMEInt	nameLen,
		NMEConstText	data,
		NMEInt	dataLen,
		NMEContext *	context,
		void *	userData
	)

Plugin implementation for date (plugin's data: date and time); write each date on a separate line (should be used with NMEOutputFormatNull)

Parameters:

[in]	name	plugin name, such as "keywords"
[in]	nameLen	length of name
[in]	data	data text
[in]	dataLen	length of data
[in,out]	context	current context
[in]	userData	comma-separated lowercase month names (multiple of 12 values for multiple languages, etc., such as "january,february,...,december,janvier,f\xc3\xa9vrier,...")

Returns:

error code (kNMEErrOk for success)

Test:

    << date 2 oct 2003 >>
    << date 2 oct 2003 12:45 >>
    << date 2 oct 2003 3 pm >>

Definition at line 117 of file NMEPluginWiki.c.

NMEErr NMEPluginExecute	(	NMEConstText	name,
		NMEInt	nameLen,
		NMEConstText	data,
		NMEInt	dataLen,
		NMEContext *	context,
		void *	userData
	)

Plugin implementation for execute (plugin's data: method name and arguments); write data without leading and trailing spaces on a separate line (should be used with NMEOutputFormatNull)

Parameters:

[in]	name	plugin name, such as "execute"
[in]	nameLen	length of name
[in]	data	data text
[in]	dataLen	length of data
[in,out]	context	current context
[in]	userData	pointer passed from the parser, as specified in NMEPlugin

Returns:

error code (kNMEErrOk for success)

Test:

    << execute makeCalendar 2009 12 >>

Definition at line 51 of file NMEPluginWiki.c.

NMEErr NMEPluginKeywords	(	NMEConstText	name,
		NMEInt	nameLen,
		NMEConstText	data,
		NMEInt	dataLen,
		NMEContext *	context,
		void *	userData
	)

Plugin implementation for keywords (plugin's data: comma-separated keywords); write each keyword on a separate line (should be used with NMEOutputFormatNull)

Parameters:

[in]	name	plugin name, such as "keywords"
[in]	nameLen	length of name
[in]	data	data text
[in]	dataLen	length of data
[in,out]	context	current context
[in]	userData	pointer passed from the parser, as specified in NMEPlugin

Returns:

error code (kNMEErrOk for success)

Test:

    << keywords wiki, creole, markup >>

Definition at line 20 of file NMEPluginWiki.c.