fc_manual.h File Reference

#include <stdio.h>
#include "support.h"
#include "manual_enums_gen.h"

Go to the source code of this file.

Data Structures
struct	tag_types

Functions
FILE *	manual_start (struct tag_types *tag_info, int manual_number)
void	manual_finalize (struct tag_types *tag_info, FILE *doc, enum manuals manual)
char *	html_special_chars (char *str, size_t *len)
bool	manual_settings (struct tag_types *tag_info)
bool	manual_commands (struct tag_types *tag_info)
bool	manual_terrain (struct tag_types *tag_info)
bool	manual_extras (struct tag_types *tag_info)
bool	manual_buildings (struct tag_types *tag_info)
bool	manual_governments (struct tag_types *tag_info)
bool	manual_units (struct tag_types *tag_info)
bool	manual_uclasses (struct tag_types *tag_info)
bool	manual_techs (struct tag_types *tag_info)

Function Documentation

html_special_chars()

char * html_special_chars	(	char *	str,
		size_t *	len
	)

Replace html special characters ('&', '<' and '>').

Definition at line 168 of file fc_manual.c.

Referenced by manual_commands(), and manual_settings().

manual_buildings()

bool manual_buildings

(

struct tag_types *

tag_info

)

Write improvements manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 136 of file manual_buildings.c.

Referenced by manual_command().

manual_commands()

bool manual_commands

(

struct tag_types *

tag_info

)

Write commands manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 33 of file manual_commands.c.

Referenced by manual_command().

manual_extras()

bool manual_extras

(

struct tag_types *

tag_info

)

Write extras manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 37 of file manual_extras.c.

Referenced by manual_command().

manual_finalize()

void manual_finalize	(	struct tag_types *	tag_info,
		FILE *	doc,
		enum manuals	manual
	)

Generic finalizing step for a manual page. Closes the file.

Parameters

tag_info	Tag set to use
doc	Manual handle
manual	Type of the manual

Definition at line 320 of file fc_manual.c.

Referenced by manual_commands(), manual_extras(), manual_governments(), manual_improvements(), manual_settings(), manual_techs(), manual_terrain(), manual_uclasses(), and manual_units().

manual_governments()

bool manual_governments

(

struct tag_types *

tag_info

)

Write governments manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 37 of file manual_governments.c.

Referenced by manual_command().

manual_settings()

bool manual_settings

(

struct tag_types *

tag_info

)

Write settings manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 33 of file manual_settings.c.

Referenced by manual_command().

manual_start()

FILE * manual_start	(	struct tag_types *	tag_info,
		int	manual_number
	)

Create manual file, and do the generic header for it.

Parameters

tag_info	Tag set to use
manual_number	Number of the manual page

Returns

Handle of the created file

Definition at line 291 of file fc_manual.c.

Referenced by manual_commands(), manual_extras(), manual_governments(), manual_improvements(), manual_settings(), manual_techs(), manual_terrain(), manual_uclasses(), and manual_units().

manual_techs()

bool manual_techs

(

struct tag_types *

tag_info

)

Write techs manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 37 of file manual_techs.c.

Referenced by manual_command().

manual_terrain()

bool manual_terrain

(

struct tag_types *

tag_info

)

Write terrain manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 33 of file manual_terrain.c.

Referenced by manual_command().

manual_uclasses()

bool manual_uclasses

(

struct tag_types *

tag_info

)

Write unit classes manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 37 of file manual_uclass.c.

Referenced by manual_command().

manual_units()

bool manual_units

(

struct tag_types *

tag_info

)

Write units manual page

Parameters

tag_info

Tag set to use

Returns

Success

Definition at line 37 of file manual_units.c.

Referenced by manual_command().