NMEPluginTOC.h File Reference

NME optional plugin for table of contents in HTML. More...

#include "NME.h"

Go to the source code of this file.

Data Structures
struct	HookTOCData
	User data for hook (opaque, typically allocated as an automatic (local) variable and passed by address to NMESetTOCOutputFormat) More...
struct	NMEPluginTocData
	User data of NMEPluginTOCEntry. More...
Defines
#define	NMEPluginTOCEntry(data)   {"toc", kNMEPluginOptBetweenPar, NMEPluginTOC, (void *)data}
	NMEPlugin entry for table of plugins.
Functions
void	NMESetTOCOutputFormat (NMEOutputFormat *f, HookTOCData *d)
	Set output format structure for TOC generation.
NMEErr	NMEPluginTOC (NMEConstText name, NMEInt nameLen, NMEConstText data, NMEInt dataLen, NMEContext *context, void *userData)
	Plugin implementation for table of contents.

---

Detailed Description

NME optional plugin for table of contents in HTML.

Author:

Yves Piguet.

Copyright:

2007-2013, Yves Piguet.

Definition in file NMEPluginTOC.h.

---

Function Documentation

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

Plugin implementation for table of contents.

Parameters:

[in]	name	plugin name, such as "toc"
[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:

    << toc level
    >>

or

    << toc level1 level2
    >>

or

    << toc level1 level2 title
    >>

Definition at line 89 of file NMEPluginTOC.c.

void NMESetTOCOutputFormat	(	NMEOutputFormat *	f,
		HookTOCData *	d
	)

Set output format structure for TOC generation.

Parameters:

[in]	f	address of output format structure, whose contents are filled
[out]	d	paragraph hook user data

Definition at line 80 of file NMEPluginTOC.c.