Skip to content

Commit 4056f58

Browse files
idrassiidrassi
committed
Documentation: remove usage of CSS collapsible to avoid breaking CHM generation. Add new entries to CHM. Remove example script file since its content is described inline in the documentation
We need to generate CHM from the same HTML files as the documentation and so we are limited by CHM compatibility
1 parent e04bf33 commit 4056f58

11 files changed

Lines changed: 288 additions & 520 deletions

‎README.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,12 @@ VI. Further Information
3838
I. Windows
3939
==========
4040

41-
A detailed guide on how to compile VeraCrypt on Windows can be found at: https://www.veracrypt.fr/en/CompilingGuidelineWin.html
41+
Requirements for Building VeraCrypt for Windows:
42+
------------------------------------------------
43+
44+
A detailed guide on how to build VeraCrypt on Windows can be found in
45+
the file doc/html/CompilingGuidelineWin.html. it is also available online
46+
at https://www.veracrypt.fr/en/CompilingGuidelineWin.html
4247

4348
IMPORTANT:
4449

@@ -87,7 +92,9 @@ For build instructions, please refer to the file src\Boot\EFI\Readme.txt.
8792
II. Linux and Mac OS X
8893
======================
8994

90-
A detailed guide on how to build a dev environment and on how to compile VeraCrypt on Linux can be found at: https://www.veracrypt.fr/en/CompilingGuidelineLinux.html
95+
A detailed guide on how to build VeraCrypt on Linux can be found in
96+
the file doc/html/CompilingGuidelineLinux.html. it is also available online
97+
at https://www.veracrypt.fr/en/CompilingGuidelineLinux.html
9198

9299
Requirements for Building VeraCrypt for Linux and Mac OS X:
93100
-----------------------------------------------------------

‎doc/chm/VeraCrypt.hhc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,20 @@
390390
<param name="Name" value="Source Code">
391391
<param name="Local" value="Source Code.html">
392392
</OBJECT>
393+
<LI> <OBJECT type="text/sitemap">
394+
<param name="Name" value="Building VeraCrypt From Source">
395+
<param name="Local" value="CompilingGuidelines.html">
396+
</OBJECT>
397+
<UL>
398+
<LI> <OBJECT type="text/sitemap">
399+
<param name="Name" value="Windows Build Guide">
400+
<param name="Local" value="CompilingGuidelineWin.html">
401+
</OBJECT>
402+
<LI> <OBJECT type="text/sitemap">
403+
<param name="Name" value="Linux Build Guide">
404+
<param name="Local" value="CompilingGuidelineLinux.html">
405+
</OBJECT>
406+
</UL>
393407
</UL>
394408
<LI> <OBJECT type="text/sitemap">
395409
<param name="Name" value="Contact">

‎doc/chm/VeraCrypt.hhp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ Cascades.html
5050
Changing Passwords and Keyfiles.html
5151
Choosing Passwords and Keyfiles.html
5252
Command Line Usage.html
53+
CompilingGuidelineLinux.html
54+
CompilingGuidelines.html
55+
CompilingGuidelineWin.html
5356
Contact.html
5457
Contributed Resources.html
5558
Converting TrueCrypt volumes and partitions.html

‎doc/chm/create_chm.bat‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ PATH=%PATH%;C:\Program Files (x86)\HTML Help Workshop
33
set CHMBUILDPATH=%~dp0
44
cd %CHMBUILDPATH%
55

6-
copy ..\html\* .
6+
xcopy /E ..\html\* .
77

88
hhc VeraCrypt.hhp
99

1010
del /F /Q *.html *.css *.jpg *.gif *.png *.svg
11+
rmdir /s /Q CompilingGuidelineWin ru

‎doc/html/CompilingGuidelineLinux.html‎

Lines changed: 29 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -16,38 +16,11 @@
1616
}
1717

1818
.texttohide {
19-
display:none;
2019
font-family: Helvetica,sans-serif;
2120
font-size: 14px;
2221
font-weight: normal;
2322
}
2423

25-
.show {
26-
display: none;
27-
text-decoration: none;
28-
}
29-
30-
.hide:target + .show {
31-
display: inline;
32-
text-decoration: none;
33-
}
34-
35-
.hide:target {
36-
display: none;
37-
text-decoration: none;
38-
}
39-
40-
.hide:target ~ .texttohide {
41-
display:inline;
42-
text-decoration: none;
43-
44-
}
45-
46-
@media print {
47-
.hide, .show {
48-
display: none;
49-
}
50-
}
5124

5225
</style>
5326

@@ -80,12 +53,16 @@
8053
<p>
8154
<a href="Documentation.html">Documentation</a>
8255
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
83-
<a href="CompilingGuidelineLinux.html">Compiling Gudineline for Linux</a>
56+
<a href="Technical%20Details.html">Technical Details</a>
57+
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
58+
<a href="CompilingGuidelines.html">Building VeraCrypt From Source</a>
59+
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
60+
<a href="CompilingGuidelineLinux.html">Linux Build Guide</a>
8461
</p></div>
8562

8663
<div class="wikidoc">
87-
This guide describes how to set up a Linux System that can compile the VeraCrypt. Further it is described how VeraCrypt is going to be compiled. <br>
88-
The procedure for a Ubuntu 22.04 LTS system is described here as an example, but the procedure for other Linux systems is analogous.
64+
This guide describes how to set up a Linux System to build VeraCrypt from source and how to perform compilation. <br>
65+
The procedure for a Ubuntu 22.04 LTS system is described here as an example, the procedure for other Linux systems is analogous.
8966
</div>
9067

9168
<div class="wikidoc">
@@ -94,7 +71,7 @@
9471
The following components are required for compiling VeraCrypt:
9572
<ol>
9673
<li>GNU Make</li>
97-
<li>GNU C++ Compiler 4.0</li>
74+
<li>GNU C/C++ Compiler</li>
9875
<li>YASM 1.3.0</li>
9976
<li>pkg-config</li>
10077
<li>wxWidgets 3.2 shared library and header files installed or wxWidgets 3.0 library source code </li>
@@ -103,8 +80,18 @@
10380
</div>
10481

10582
<div class="wikidoc">
106-
If you do not want to perform the single steps below, you can run these commands to build an environment and to compile VeraCrpyt: <br>
107-
Download as script: <a href="LinuxPrepAndBuild.sh" target="_blank">Script</a> <br>
83+
<p>Below are the detailed procedure steps:</p>
84+
<ul>
85+
<li><a href="#InstallationOfGNUMake">Installation of GNU Make</a></li>
86+
<li><a href="#InstallationOfGNUCompiler">Installation of GNU C/C++ Compiler</a></li>
87+
<li><a href="#InstallationOfYASM">Installation of YASM</a></li>
88+
<li><a href="#InstallationOfPKGConfig">Installation of pkg-config</a></li>
89+
<li><a href="#InstallationOfwxWidgets">Installation of wxWidgets 3.2</a></li>
90+
<li><a href="#InstallationOfFuse">Installation of libfuse</a></li>
91+
<li><a href="#DownloadVeraCrypt">Download VeraCrypt</a></li>
92+
<li><a href="#CompileVeraCrypt">Compile VeraCrypt</a></li>
93+
</ul>
94+
<p>They can also be performed by running the below list of commands in a terminal or by copying them to a script:</p>
10895
<code>
10996
sudo apt update <br>
11097
sudo apt install -y build-essential yasm pkg-config libgtk-3-dev <br>
@@ -125,12 +112,12 @@
125112
cd ~/VeraCrypt/src <br>
126113
make
127114
</code>
115+
<p>
128116
</div>
129117

130118
<div class="wikidoc">
131119
<div class="textbox" id="InstallationOfGNUMake">
132-
<a href="#hide1" class="hide" id="hide1">Installation of GNU Make</a>
133-
<a href="#show1" class="show" id="show1">Installation of GNU Make</a>
120+
<a href="#InstallationOfGNUMake">Installation of GNU Make</a>
134121
<div class="texttohide">
135122
<p>
136123
<ol>
@@ -150,8 +137,7 @@
150137
</div>
151138

152139
<div class="textbox" id="InstallationOfGNUCompiler">
153-
<a href="#hide2" class="hide" id="hide2">Installation of GNU C++ Compiler 4.0</a>
154-
<a href="#show2" class="show" id="show2">Installation of GNU C++ Compiler 4.0</a>
140+
<a href="#InstallationOfGNUCompiler">Installation of GNU C/C++ Compiler</a>
155141
<div class="texttohide">
156142
<p> If the build-essential were already installed in the step before, this step can be skipped.
157143
<ol>
@@ -171,8 +157,7 @@
171157
</div>
172158

173159
<div class="textbox" id="InstallationOfYASM">
174-
<a href="#hide3" class="hide" id="hide3">Installation of YASM</a>
175-
<a href="#show3" class="show" id="show3">Installation of YASM</a>
160+
<a href="#InstallationOfYASM">Installation of YASM</a>
176161
<div class="texttohide">
177162
<p>
178163
<ol>
@@ -192,8 +177,7 @@
192177
</div>
193178

194179
<div class="textbox" id="InstallationOfPKGConfig">
195-
<a href="#hide4" class="hide" id="hide4">Installation of pkg-config</a>
196-
<a href="#show4" class="show" id="show4">Installation of pkg-config</a>
180+
<a href="#InstallationOfPKGConfig">Installation of pkg-config</a>
197181
<div class="texttohide">
198182
<p>
199183
<ol>
@@ -213,8 +197,7 @@
213197
</div>
214198

215199
<div class="textbox" id="InstallationOfwxWidgets">
216-
<a href="#hide5" class="hide" id="hide5">Installation of wxWidgets 3.2</a>
217-
<a href="#show5" class="show" id="show5">Installation of wxWidgets 3.2</a>
200+
<a href="#InstallationOfwxWidgets">Installation of wxWidgets 3.2</a>
218201
<div class="texttohide">
219202
<p>
220203
<ol>
@@ -244,8 +227,7 @@
244227
</div>
245228

246229
<div class="textbox" id="InstallationOfFuse">
247-
<a href="#hide6" class="hide" id="hide6">Installation of libfuse</a>
248-
<a href="#show6" class="show" id="show6">Installation of libfuse</a>
230+
<a href="#InstallationOfFuse">Installation of libfuse</a>
249231
<div class="texttohide">
250232
<p>
251233
<ol>
@@ -265,8 +247,7 @@
265247
</div>
266248

267249
<div class="textbox" id="DownloadVeraCrypt">
268-
<a href="#hide7" class="hide" id="hide7">Download VeraCrypt</a>
269-
<a href="#show7" class="show" id="show7">Download VeraCrypt</a>
250+
<a href="#DownloadVeraCrypt">Download VeraCrypt</a>
270251
<div class="texttohide">
271252
<p>
272253
<ol>
@@ -287,8 +268,7 @@
287268
</div>
288269

289270
<div class="textbox" id="CompileVeraCrypt">
290-
<a href="#hide8" class="hide" id="hide8">Compile VeraCrypt</a>
291-
<a href="#show8" class="show" id="show8">Compile VeraCrypt</a>
271+
<a href="#CompileVeraCrypt">Compile VeraCrypt</a>
292272
<div class="texttohide">
293273
<p> Remarks: <br>
294274
<ul>

0 commit comments

Comments
 (0)