1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/*LICENSE_START*/
/*
* Copyright 1995-2002 Washington University School of Medicine
*
* http://brainmap.wustl.edu
*
* This file is part of CARET.
*
* CARET is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* CARET is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with CARET; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
/*LICENSE_END*/
#include "CaretVersion.h"
#include "CommandHelpHTML.h"
#include "DateAndTime.h"
#include "FileFilters.h"
#include "ProgramParameters.h"
#include "ScriptBuilderParameters.h"
#include "TextFile.h"
/**
* constructor.
*/
CommandHelpHTML::CommandHelpHTML()
: CommandBase("-help-html",
"HELP WRITE TO HTML FILE")
{
}
/**
* destructor.
*/
CommandHelpHTML::~CommandHelpHTML()
{
}
/**
* get the script builder parameters.
*/
void
CommandHelpHTML::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{
paramsOut.clear();
paramsOut.addFile("Output HTML File Name", FileFilters::getHTMLFileFilter());
}
/**
* get full help information.
*/
QString
CommandHelpHTML::getHelpInformation() const
{
QString helpInfo =
(indent3 + getShortDescription() + "\n"
+ indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + " \n"
+ indent9 + "<output-html-file-name>\n"
+ indent9 + "\n"
+ indent9 + " Print the help information to an HTML file.\n"
+ indent9 + "\n");
return helpInfo;
}
/**
* execute the command.
*/
void
CommandHelpHTML::executeCommand() throw (BrainModelAlgorithmException,
CommandException,
FileException,
ProgramParametersException,
StatisticException)
{
//
// Store the commands
//
std::vector<CommandBase*> commands;
CommandBase::getAllCommandsSortedBySwitch(commands);
const int numCommands = static_cast<int>(commands.size());
//
// Get name of output file
//
const QString htmlFileExtension(".html");
QString htmlFileName = parameters->getNextParameterAsString("PDF File Name");
if (htmlFileName.endsWith(htmlFileExtension) == false) {
htmlFileName += htmlFileExtension;
}
TextFile htmlFile;
htmlFile.appendLine("<html>");
htmlFile.appendLine("<body>");
htmlFile.appendLine("<head>");
htmlFile.appendLine("<title>Caret Command Help</title>");
htmlFile.appendLine("</head>");
htmlFile.appendLine("<h1>Caret Command Manual</h1>");
htmlFile.appendLine("<h2>Version "
+ CaretVersion::getCaretVersionAsString()
+ "</h2>");
htmlFile.appendLine("<h2>Date Printed "
+ DateAndTime::getDateAndTimeAsString()
+ "</h2>");
htmlFile.appendLine("<p></p>");
htmlFile.appendLine("<p></p>");
htmlFile.appendText(convertToHTML(getGeneralHelpInformation()));
if (numCommands > 0) {
std::vector<QString> anchorNames(numCommands, "");
for (int i = 0; i < numCommands; i++) {
const CommandBase* command = commands[i];
const QString anchorName = command->getShortDescription().replace(' ', '_');
anchorNames[i] = anchorName;
htmlFile.appendText("<a href=\"#"
+ anchorName
+ "\">"
+ command->getShortDescription()
+ "</a><br></br>");
}
for (int i = 0; i < numCommands; i++) {
if (i > 0) {
htmlFile.appendLine("<hr=2></hr>");
}
const CommandBase* command = commands[i];
QString htmlString = convertToHTML(command->getHelpInformation());
/*
htmlString = htmlString.replace(' ', " ");
htmlString = htmlString.replace('<', "<");
htmlString = htmlString.replace('>', ">");
htmlString = htmlString.replace("\n", "<br></br>"); // do after less than/greater than conversion
*/
htmlFile.appendText("<a name=\""
+ anchorNames[i]
+ "\"></a>"
+ htmlString);
}
}
htmlFile.appendLine("</body>");
htmlFile.appendLine("</html>");
htmlFile.writeFile(htmlFileName);
}
/**
* convert a string to HTML.
*/
QString
CommandHelpHTML::convertToHTML(const QString& sin) const
{
QString s = sin;
s = s.replace(' ', " ");
s = s.replace('<', "<");
s = s.replace('>', ">");
s = s.replace('\n', "<br>"); // do after less than/greater than conversion
return s;
}
|
