Freeciv-3.2: /fast/freeciv/nightly/S3_2/tools/manual/fc_manual.h Source File

Freeciv-3.2

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#define SPECENUM_NAME manuals
26#define SPECENUM_VALUE0 MANUAL_SETTINGS
27#define SPECENUM_VALUE0NAME N_("Settings")
28#define SPECENUM_VALUE1 MANUAL_COMMANDS
29#define SPECENUM_VALUE1NAME N_("Commands")
30#define SPECENUM_VALUE2 MANUAL_TERRAIN
31#define SPECENUM_VALUE2NAME N_("Terrain")
32#define SPECENUM_VALUE3 MANUAL_EXTRAS
33#define SPECENUM_VALUE3NAME N_("Extras")
34#define SPECENUM_VALUE4 MANUAL_BUILDINGS
35#define SPECENUM_VALUE4NAME N_("Buildings")
36#define SPECENUM_VALUE5 MANUAL_WONDERS
37#define SPECENUM_VALUE5NAME N_("Wonders")
38#define SPECENUM_VALUE6 MANUAL_GOVS
39#define SPECENUM_VALUE6NAME N_("Governments")
40#define SPECENUM_VALUE7 MANUAL_UNITS
41#define SPECENUM_VALUE7NAME N_("Units")
42#define SPECENUM_VALUE8 MANUAL_TECHS
43#define SPECENUM_VALUE8NAME N_("Techs")
44#define SPECENUM_COUNT MANUAL_COUNT
45#include "specenum_gen.h"
46
47 struct tag_types {
48 const char *file_ext;
49 const char *header;
50 const char *title_begin;
51 const char *title_end;
52 const char *sect_title_begin;
53 const char *sect_title_end;
54 const char *image_begin;
55 const char *image_end;
56 const char *item_begin;
57 const char *item_end;
58 const char *subitem_begin;
59 const char *subitem_end;
60 const char *tail;
61 const char *hline;
62};
63
64/* Utility functions */
65 FILE *manual_start(struct tag_types *tag_info, int manual_number);
66void manual_finalize(struct tag_types *tag_info, FILE *doc,
67 enum manuals manual);
68char *html_special_chars(char *str, size_t *len);
69
70/* Individual manual pages */
71bool manual_settings(struct tag_types *tag_info);
72bool manual_commands(struct tag_types *tag_info);
73bool manual_terrain(struct tag_types *tag_info);
74bool manual_extras(struct tag_types *tag_info);
75bool manual_buildings(struct tag_types *tag_info);
76bool manual_governments(struct tag_types *tag_info);
77bool manual_units(struct tag_types *tag_info);
78bool manual_techs(struct tag_types *tag_info);
79
80#ifdef __cplusplus
81}
82#endif /* __cplusplus */
83
84#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
specenum_gen.h
tag_types
Definition fc_manual.h:47
tag_types::tail
const char * tail
Definition fc_manual.h:60
tag_types::subitem_begin
const char * subitem_begin
Definition fc_manual.h:58
tag_types::header
const char * header
Definition fc_manual.h:49
tag_types::item_begin
const char * item_begin
Definition fc_manual.h:56
tag_types::file_ext
const char * file_ext
Definition fc_manual.h:48
tag_types::sect_title_end
const char * sect_title_end
Definition fc_manual.h:53
tag_types::title_begin
const char * title_begin
Definition fc_manual.h:50
tag_types::image_end
const char * image_end
Definition fc_manual.h:55
tag_types::hline
const char * hline
Definition fc_manual.h:61
tag_types::item_end
const char * item_end
Definition fc_manual.h:57
tag_types::sect_title_begin
const char * sect_title_begin
Definition fc_manual.h:52
tag_types::title_end
const char * title_end
Definition fc_manual.h:51
tag_types::subitem_end
const char * subitem_end
Definition fc_manual.h:59
tag_types::image_begin
const char * image_begin
Definition fc_manual.h:54
support.h