1 /**********************************************************************
2  *
3  *   FreeDoko a Doppelkopf-Game
4  *
5  *   Copyright (C) 2001 – 2018 by Diether Knof and Borg Enders
6  *
7  *   This program is free software; you can redistribute it and/or
8  *   modify it under the terms of the GNU General Public License as
9  *   published by the Free Software Foundation; either version 2 of
10  *   the License, or (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  *   You can find this license in the file 'gpl.txt'.
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,
21  *   MA  02111-1307  USA
22  *
23  *  Contact:
24  *    Diether Knof dknof@posteo.de
25  *
26  **********************************************************************/
27 
28 #pragma once
29 
30 #include "constants.h"
31 
32 #include "../basetypes.h"
33 #include "../party/rule.h"
34 #include "../misc/preferences.h"
35 
36 // functions for the help
37 namespace Help {
38 
39   void show(string const& location);
40 
41   // the homepage location
42   string homepage_location();
43   // the location of cardsets to download
44   string cardsets_download_location();
45 
46   // the location of the helpfile in the manual
47 
48   string manual_location(string const& page = "overview.html");
49   string operation_location(string const& page);
50 
51 
52   // the location of the specific help
53 
54   string location(Rule::Type::Bool type);
55   string location(Rule::Type::Unsigned type);
56 
57   string location(Preferences::Type::Bool type);
58   string location(Preferences::Type::Unsigned type);
59   string location(Preferences::Type::String type);
60   string location(Preferences::Type::CardsOrder type);
61 
62 }; // namespace Help
63