texinfo/info/footnotes.h

   1 /* footnotes.h -- Some functions for manipulating footnotes.
   2    $Id: footnotes.h,v 1.1.1.2 1998/03/22 20:42:30 law Exp $
   3
   4    This file is part of GNU Info, a program for reading online documentation
   5    stored in Info format.
   6
   7    Copyright (C) 1993, 97 Free Software Foundation, Inc.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2, or (at your option)
  12    any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22
  23    Written by Brian Fox (bfox@ai.mit.edu). */
  24
  25 #ifndef INFO_FOOTNOTES_H
  26 #define INFO_FOOTNOTES_H
  27
  28 /* Magic string which indicates following text is footnotes. */
  29 #define FOOTNOTE_LABEL _("---------- Footnotes ----------")
  30
  31 #define FN_FOUND   0
  32 #define FN_UNFOUND 1
  33 #define FN_UNABLE  2
  34
  35
  36 /* Create or delete the footnotes window depending on whether footnotes
  37    exist in WINDOW's node or not.  Returns FN_FOUND if footnotes were found
  38    and displayed.  Returns FN_UNFOUND if there were no footnotes found
  39    in WINDOW's node.  Returns FN_UNABLE if there were footnotes, but the
  40    window to show them couldn't be made. */
  41 extern int info_get_or_remove_footnotes ();
  42
  43 /* Non-zero means attempt to show footnotes when displaying a new window. */
  44 extern int auto_footnotes_p;
  45
  46 #endif /* not INFO_FOOTNOTES_H */