toc.h revision 114472
155079Sache/* toc.h -- table of contents handling.
255079Sache   $Id: toc.h,v 1.1 2002/08/25 23:38:39 karl Exp $
355079Sache
455079Sache   Copyright (C) 1999 Free Software Foundation, Inc.
555079Sache
655079Sache   This program is free software; you can redistribute it and/or modify
755079Sache   it under the terms of the GNU General Public License as published by
855079Sache   the Free Software Foundation; either version 2, or (at your option)
955079Sache   any later version.
1055079Sache
1155079Sache   This program is distributed in the hope that it will be useful,
1255079Sache   but WITHOUT ANY WARRANTY; without even the implied warranty of
1355079Sache   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1455079Sache   GNU General Public License for more details.
1555079Sache
1655079Sache   You should have received a copy of the GNU General Public License
1755079Sache   along with this program; if not, write to the Free Software
1855079Sache   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1955079Sache
2055079Sache   Written by Karl Heinz Marbaise <kama@hippo.fido.de>.  */
2155079Sache
2255079Sache#ifndef TOC_H
2355079Sache#define TOC_H
2455079Sache
2555079Sache/* the file where we found the @contents directive */
2655079Sacheextern char *contents_filename;
2755079Sache
2855079Sache/* the file where we found the @shortcontents directive */
2955079Sacheextern char *shortcontents_filename;
3055079Sache
3155079Sache/* Structure to hold one entry for the toc. */
3255079Sachetypedef struct toc_entry_elt {
3355079Sache  char *name;
3455079Sache  char *containing_node; /* Name of node containing this section.  */
3555079Sache  char *html_file;       /* Name of HTML node-file in split-HTML mode */
3655079Sache  int number;            /* counting number from 0...n independent from
3755079Sache                            chapter/section can be used for anchors or
3855079Sache                            references to it.  */
3955079Sache  int level;             /* level: chapter, section, subsection... */
4055079Sache} TOC_ENTRY_ELT;
4155079Sache
4255079Sache/* all routines which have relationship with TOC should start with
4355079Sache   toc_ (this is a kind of name-space) */
4455079Sacheextern int toc_add_entry (); /* return the number for the toc-entry */
4555079Sacheextern void toc_free ();
4655079Sacheextern char *toc_find_section_of_node ();
4755079Sache
4855079Sacheextern void cm_contents (), cm_shortcontents ();
4955079Sache
5055079Sache#endif /* not TOC_H */
5155079Sache