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