contrib/texinfo/info/footnotes.h

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