Freeciv-3.3: /fast/freeciv/nightly/main/tools/manual/fc_manual.h Source File

Freeciv-3.3

Loading...
Searching...
No Matches
fc_manual.h
Go to the documentation of this file.
1/***********************************************************************
2 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License as published by
5 the Free Software Foundation; either version 2, or (at your option)
6 any later version.
7
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
12***********************************************************************/
13#ifndef FC__FC_MANUAL_H
14#define FC__FC_MANUAL_H
15
16#ifdef __cplusplus
17extern "C" {
18#endif /* __cplusplus */
19
20#include <stdio.h> /* FILE */
21
22/* utility */
23#include "support.h"
24
25/* gen_headers/enums */
26#include "manual_enums_gen.h"
27
28 struct tag_types {
29 const char *file_ext;
30 const char *header;
31 const char *title_begin;
32 const char *title_end;
33 const char *sect_title_begin;
34 const char *sect_title_end;
35 const char *image_begin;
36 const char *image_end;
37 const char *item_begin;
38 const char *item_end;
39 const char *subitem_begin;
40 const char *subitem_end;
41 const char *tail;
42 const char *hline;
43};
44
45/* Utility functions */
46 FILE *manual_start(struct tag_types *tag_info, int manual_number);
47void manual_finalize(struct tag_types *tag_info, FILE *doc,
48 enum manuals manual);
49char *html_special_chars(char *str, size_t *len);
50
51/* Individual manual pages */
52bool manual_settings(struct tag_types *tag_info);
53bool manual_commands(struct tag_types *tag_info);
54bool manual_terrain(struct tag_types *tag_info);
55bool manual_extras(struct tag_types *tag_info);
56bool manual_buildings(struct tag_types *tag_info);
57bool manual_governments(struct tag_types *tag_info);
58bool manual_units(struct tag_types *tag_info);
59bool manual_techs(struct tag_types *tag_info);
60
61#ifdef __cplusplus
62}
63#endif /* __cplusplus */
64
65#endif /* FC__FC_MANUAL_H */
str
#define str
Definition astring.c:76
incite_cost
char * incite_cost
Definition comments.c:74
manual_terrain
bool manual_terrain(struct tag_types *tag_info)
Definition manual_terrain.c:33
manual_units
bool manual_units(struct tag_types *tag_info)
Definition manual_units.c:37
manual_finalize
void manual_finalize(struct tag_types *tag_info, FILE *doc, enum manuals manual)
Definition fc_manual.c:316
manual_buildings
bool manual_buildings(struct tag_types *tag_info)
Definition manual_buildings.c:136
manual_extras
bool manual_extras(struct tag_types *tag_info)
Definition manual_extras.c:37
manual_settings
bool manual_settings(struct tag_types *tag_info)
Definition manual_settings.c:33
manual_governments
bool manual_governments(struct tag_types *tag_info)
Definition manual_governments.c:37
html_special_chars
char * html_special_chars(char *str, size_t *len)
Definition fc_manual.c:164
manual_start
FILE * manual_start(struct tag_types *tag_info, int manual_number)
Definition fc_manual.c:287
manual_commands
bool manual_commands(struct tag_types *tag_info)
Definition manual_commands.c:33
manual_techs
bool manual_techs(struct tag_types *tag_info)
Definition manual_techs.c:37
len
int len
Definition packhand.c:127
tag_types
Definition fc_manual.h:28
tag_types::tail
const char * tail
Definition fc_manual.h:41
tag_types::subitem_begin
const char * subitem_begin
Definition fc_manual.h:39
tag_types::header
const char * header
Definition fc_manual.h:30
tag_types::item_begin
const char * item_begin
Definition fc_manual.h:37
tag_types::file_ext
const char * file_ext
Definition fc_manual.h:29
tag_types::sect_title_end
const char * sect_title_end
Definition fc_manual.h:34
tag_types::title_begin
const char * title_begin
Definition fc_manual.h:31
tag_types::image_end
const char * image_end
Definition fc_manual.h:36
tag_types::hline
const char * hline
Definition fc_manual.h:42
tag_types::item_end
const char * item_end
Definition fc_manual.h:38
tag_types::sect_title_begin
const char * sect_title_begin
Definition fc_manual.h:33
tag_types::title_end
const char * title_end
Definition fc_manual.h:32
tag_types::subitem_end
const char * subitem_end
Definition fc_manual.h:40
tag_types::image_begin
const char * image_begin
Definition fc_manual.h:35
support.h