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