1 #ifndef CoCoA_OnlineHelp_H 2 #define CoCoA_OnlineHelp_H 3 4 // Copyright (c) 2010 Anna Bigatti 5 6 // This file is part of the source of CoCoALib, the CoCoA Library. 7 8 // CoCoALib 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 3 of the License, or 11 // (at your option) any later version. 12 13 // CoCoALib 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 CoCoALib. If not, see <http://www.gnu.org/licenses/>. 20 21 #include <string> 22 //using std::string; 23 #include <vector> 24 //using std::vector; 25 26 27 namespace CoCoA 28 { 29 namespace OnlineHelp 30 { 31 32 void PrintMan(std::ostream &out, std::string keyword); 33 void ReloadMan(std::ostream &out); 34 void ReloadMan(std::ostream &out, const std::vector<std::string>& FileNames); 35 void PrintAllExamples(std::ostream &out); 36 void PrintAllExamplesWithoutOutput(std::ostream &out); 37 void PrintWordlist(std::ostream &out); 38 const char* XMLFileName(); 39 40 } // namespace OnlineHelp 41 } // namespace CoCoA 42 43 44 // RCS header/log in the next few lines 45 // $Header: /Volumes/Home_1/cocoa/cvs-repository/CoCoALib-0.99/src/CoCoA-5/OnlineHelp.H,v 1.12 2018/03/08 17:00:07 bigatti Exp $ 46 // $Log: OnlineHelp.H,v $ 47 // Revision 1.12 2018/03/08 17:00:07 bigatti 48 // -- ReloadMan: now many manual files can be loaded 49 // 50 // Revision 1.11 2014/03/26 11:50:43 abbott 51 // Summary: Changed signature of PrintMan (1st arg was const string&, now string) 52 // Author: JAA 53 // 54 // Revision 1.10 2012/06/04 09:34:05 bigatti 55 // -- added PrintWordlist 56 // 57 // Revision 1.9 2012/04/04 13:56:35 bigatti 58 // -- added PrintAllExamplesWithoutOutput 59 // 60 // Revision 1.8 2012/02/24 13:10:12 bigatti 61 // -- added ReloadMan 62 // 63 // Revision 1.7 2011/02/16 16:14:08 bigatti 64 // -- class deefinition moved into .C file 65 // -- added storing of types, and function for <commands_and_functions_for> 66 // -- cleaning up 67 // 68 // Revision 1.6 2011/02/14 10:10:07 bigatti 69 // -- fixed & ' <backslash/> ... 70 // -- added function PrintAllExamples 71 // 72 // Revision 1.5 2010/09/01 13:24:48 bigatti 73 // -- moved all manual functions into CoCoA::OnlineHelp namespace 74 // 75 // Revision 1.4 2010/09/01 12:27:52 lagorio 76 // *** empty log message *** 77 // 78 // Revision 1.3 2010/09/01 07:46:19 lagorio 79 // *** empty log message *** 80 // 81 // Revision 1.2 2010/08/31 14:55:58 bigatti 82 // -- added cvs log 83 // 84 85 #endif 86