Back to index

tetex-bin  3.0
sectioning.h
Go to the documentation of this file.
00001 /* sectioning.h -- all related stuff @chapter, @section... @contents
00002    $Id: sectioning.h,v 1.5 2004/04/11 17:56:47 karl Exp $
00003 
00004    Copyright (C) 1999, 2003 Free Software Foundation, Inc.
00005 
00006    This program is free software; you can redistribute it and/or modify
00007    it under the terms of the GNU General Public License as published by
00008    the Free Software Foundation; either version 2, or (at your option)
00009    any later version.
00010 
00011    This program is distributed in the hope that it will be useful,
00012    but WITHOUT ANY WARRANTY; without even the implied warranty of
00013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014    GNU General Public License for more details.
00015 
00016    You should have received a copy of the GNU General Public License
00017    along with this program; if not, write to the Free Software
00018    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00019 
00020    Written by Karl Heinz Marbaise <kama@hippo.fido.de>.  */
00021 
00022 #ifndef SECTIONING_H
00023 #define SECTIONING_H
00024 
00025 /* Sectioning.  */
00026 
00027 /* Level 4.  */
00028 extern void cm_chapter (void),
00029   cm_unnumbered (void),
00030   cm_appendix (void),
00031   cm_top (void);
00032 
00033 /* Level 3.  */
00034 extern void cm_section (void),
00035   cm_unnumberedsec (void),
00036   cm_appendixsec (void);
00037 
00038 /* Level 2.  */
00039 extern void cm_subsection (void),
00040   cm_unnumberedsubsec (void),
00041   cm_appendixsubsec (void);
00042 
00043 /* Level 1.  */
00044 extern void cm_subsubsection (void),
00045   cm_unnumberedsubsubsec (void),
00046   cm_appendixsubsubsec (void);
00047 
00048 /* Headings.  */
00049 extern void cm_heading (void),
00050   cm_chapheading (void),
00051   cm_subheading (void),
00052   cm_subsubheading (void),
00053   cm_majorheading (void);
00054 
00055 extern void cm_raisesections (void),
00056   cm_lowersections (void),
00057   cm_ideprecated (int arg, int start, int end);
00058 
00059 extern void
00060   sectioning_underscore (char *cmd),
00061   insert_and_underscore (int level, char *cmd);
00062 
00063 /* needed in node.c */
00064 extern int set_top_section_level (int level);
00065 
00066 extern void sectioning_html (int level, char *cmd);
00067 extern int what_section (char *text, char **secname);
00068 extern char *current_chapter_number (void),
00069   *current_sectioning_number (void),
00070   *current_sectioning_name (void);
00071 
00072 /* The argument of @settitle, used for HTML. */
00073 extern char *title;
00074 
00075 
00076 /* Here is a structure which associates sectioning commands with
00077    an integer that reflects the depth of the current section. */
00078 typedef struct
00079 {
00080   char *name;
00081   int level; /* I can't replace the levels with defines
00082                 because it is changed during run */
00083   int num; /* ENUM_SECT_NO means no enumeration...
00084               ENUM_SECT_YES means enumerated version
00085               ENUM_SECT_APP appendix (Character enumerated
00086                             at first position */
00087   int toc; /* TOC_NO means do not enter in toc;
00088               TOC_YES means enter it in toc */
00089 } section_alist_type;
00090 
00091 extern section_alist_type section_alist[];
00092 
00093 /* enumerate sections */
00094 #define ENUM_SECT_NO  0
00095 #define ENUM_SECT_YES 1
00096 #define ENUM_SECT_APP 2
00097 
00098 /* make entries into toc no/yes */
00099 #define TOC_NO  0
00100 #define TOC_YES 1
00101 
00102 
00103 #endif /* not SECTIONING_H */