help.h File Reference

#include "obstack.h"

Include dependency graph for help.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	help_page_defn
struct	a_textbuffer
	TextBuffer. More...
struct	a_helpnode
	Help Node. More...
Defines
#define	HELP_OUTPUT_CC_NONE   0
#define	HELP_OUTPUT_CC_FILES   1
Typedefs
typedef enum help_output_mode	HelpOutputMode
typedef enum help_page	HelpPage
typedef help_page_defn	HelpPageDefn
typedef a_textbuffer	TextBuffer
	TextBuffer.
typedef a_helpnode	HelpNode
	Help Node.
Enumerations
enum	nodeclass {   miscnode, utypenode, mtypenode, ttypenode,   atypenode }
enum	help_output_mode {   HELP_OUTPUT_PLAIN_TEXT = 0, HELP_OUTPUT_HTML, HELP_OUTPUT_TEXI, HELP_OUTPUT_XML,   HELP_OUTPUT_LATEX, HELP_OUTPUT_MAGIC_TEXT }
enum	help_page {   HELP_PAGE_NONE = 0, HELP_PAGE_MASTER_INDEX, HELP_PAGE_TOC, HELP_PAGE_COPYRIGHT,   HELP_PAGE_WARRANTY, HELP_PAGE_NEWS, HELP_PAGE_INSTRUCTIONS, HELP_PAGE_GAME_OVERVIEW,   HELP_PAGE_SCORING, HELP_PAGE_MODULES, HELP_PAGE_GAME_SETUP, HELP_PAGE_WORLD,   HELP_PAGE_UTYPE, HELP_PAGE_TTYPE, HELP_PAGE_MTYPE, HELP_PAGE_ATYPE,   HELP_PAGE_CONCEPTS }
Functions
void	tbprintf (TextBuffer *buf, char *str,...)
void	tbcat (TextBuffer *buf, char *str)
void	tbcat_si (TextBuffer *buf, char *str)
void	tbcatline (TextBuffer *buf, char *str)
void	tbcatline_si (TextBuffer *buf, char *str)
void	init_help (void)
HelpNode *	create_help_node (void)
HelpNode *	add_help_node (char *key, void(*fn)(int, char *, TextBuffer *), int arg, HelpNode *prevnode)
HelpNode *	find_help_node (HelpNode *node, char *str)
void	create_game_help_nodes (void)
char *	get_help_text (HelpNode *node)
void	describe_topics (int arg, char *key, TextBuffer *buf)
void	describe_command (int ch, char *name, char *help, int onechar, TextBuffer *buf)
void	append_blurb_strings (char *buf, Obj *notes)
void	notify_instructions (void)
void	print_any_news (void)
void	print_game_description_to_file (FILE *fp)
void	describe_copyright (int arg, char *key, TextBuffer *buf)
void	describe_warranty (int arg, char *key, TextBuffer *buf)
void	set_help_output_cc (int cctarget)
void	set_help_output_mode (HelpOutputMode houtmode)
void	set_help_output_dir (char *)
void	set_help_toc_filep (FILE *htocfilep)
FILE *	prep_help_file (char *hfilename)
void	finish_help_file (FILE *hfilep)
void	write_help_file_header (FILE *hfile, char *headerdata)
void	write_help_file_footer (FILE *hfile, char *footerdata)
void	write_help_toc_entry (char *hfilebname, char *sectionname, int indentlvl)
char *	help_file_brand (void)
char *	get_help_file_extension (void)
Variables
HelpNode *	first_help_node
	First Help Node.
HelpNode *	copying_help_node
HelpNode *	warranty_help_node

---

Define Documentation

#define HELP_OUTPUT_CC_FILES   1

#define HELP_OUTPUT_CC_NONE   0

---

Typedef Documentation

typedef struct a_helpnode HelpNode

Help Node.

typedef enum help_output_mode HelpOutputMode

typedef enum help_page HelpPage

typedef struct help_page_defn HelpPageDefn

typedef struct a_textbuffer TextBuffer

TextBuffer.

---

Enumeration Type Documentation

enum help_output_mode

Enumeration values: HELP_OUTPUT_PLAIN_TEXT  Plain Text HELP_OUTPUT_HTML  Hypertext Markup Language HELP_OUTPUT_TEXI  GNU TexInfo HELP_OUTPUT_XML  Extensible Markup Language HELP_OUTPUT_LATEX  LaTeX HELP_OUTPUT_MAGIC_TEXT  Text with UI-Parseable Format Codes

enum help_page

Enumeration values: HELP_PAGE_NONE  HELP_PAGE_MASTER_INDEX  HELP_PAGE_TOC  HELP_PAGE_COPYRIGHT  HELP_PAGE_WARRANTY  HELP_PAGE_NEWS  HELP_PAGE_INSTRUCTIONS  HELP_PAGE_GAME_OVERVIEW  HELP_PAGE_SCORING  HELP_PAGE_MODULES  HELP_PAGE_GAME_SETUP  HELP_PAGE_WORLD  HELP_PAGE_UTYPE  HELP_PAGE_TTYPE  HELP_PAGE_MTYPE  HELP_PAGE_ATYPE  HELP_PAGE_CONCEPTS

enum nodeclass

Enumeration values: miscnode  Miscellaneous node. utypenode  Unit node. mtypenode  Material node. ttypenode  Terrain node. atypenode  Advance node.

---

Function Documentation

HelpNode* add_help_node (  char *  key, void(*  fn)(int, char *, TextBuffer *), int  arg, HelpNode *  prevnode )

void append_blurb_strings (  char *  buf, Obj *  notes )

void create_game_help_nodes (  void   )

HelpNode* create_help_node (  void   )

void describe_command (  int  ch, char *  name, char *  help, int  onechar, TextBuffer *  buf )

void describe_copyright (  int  arg, char *  key, TextBuffer *  buf )

void describe_topics (  int  arg, char *  key, TextBuffer *  buf )

void describe_warranty (  int  arg, char *  key, TextBuffer *  buf )

HelpNode* find_help_node (  HelpNode *  node, char *  str )

void finish_help_file (  FILE *  hfilep  )

char* get_help_file_extension (  void   )

char* get_help_text (  HelpNode *  node  )

char* help_file_brand (  void   )

void init_help (  void   )

void notify_instructions (  void   )

FILE* prep_help_file (  char *  hfilename  )

void print_any_news (  void   )

void print_game_description_to_file (  FILE *  fp  )

void set_help_output_cc (  int  cctarget  )

void set_help_output_dir (  char *   )

void set_help_output_mode (  HelpOutputMode  houtmode  )

void set_help_toc_filep (  FILE *  htocfilep  )

void tbcat (  TextBuffer *  buf, char *  str )

void tbcat_si (  TextBuffer *  buf, char *  str )

void tbcatline (  TextBuffer *  buf, char *  str )

void tbcatline_si (  TextBuffer *  buf, char *  str )

void tbprintf (  TextBuffer *  buf, char *  str, ...  )

void write_help_file_footer (  FILE *  hfile, char *  footerdata )

void write_help_file_header (  FILE *  hfile, char *  headerdata )

void write_help_toc_entry (  char *  hfilebname, char *  sectionname, int  indentlvl )

---

Variable Documentation

HelpNode* copying_help_node

Pointer to "Copying" help node.

HelpNode* first_help_node

First Help Node.

HelpNode* warranty_help_node

Pointer to "Warranty" help node.

---