Skip to content

Commit 3627190

Browse files
falkTXfalkTX
committed
Add documentation
Signed-off-by: falkTX <falktx@falktx.com>
1 parent c69641a commit 3627190

File tree

86 files changed

+629
-43
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+629
-43
lines changed

‎archiso/liveusb/packages.x86_64

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ amd-ucode
55
base
66
breeze
77
cloud-init
8+
cpupower
89
edk2-shell
910
efibootmgr
1011
intel-ucode
@@ -16,6 +17,7 @@ memtest86+
1617
mkinitcpio
1718
mkinitcpio-archiso
1819
nano
19-
okular
2020
openssh
21+
rtirq
2122
syslinux
23+
thermald

‎documentation/index.html

+373
Large diffs are not rendered by default.

‎documentation/index_files/1000px-AssigmentToMIDIController.png

82.1 KB

‎documentation/index_files/1000px-AssignmentsWindow.png

46.2 KB

‎documentation/index_files/1000px-CVPlugins.png

336 KB

‎documentation/index_files/1000px-DUOX_AssignToCV.png

111 KB

‎documentation/index_files/1000px-InternalCV.png

48.1 KB

‎documentation/index_files/1000px-NoCV.png

115 KB

‎documentation/index_files/1000px-RemovingAssignment.png

46.9 KB

‎documentation/index_files/1200px-SnapshotsMenu.png

705 KB

‎documentation/index_files/150px-ManageCVPortsButton.png

8.44 KB

‎documentation/index_files/150px-SnapshotsButton.png

2.14 KB

‎documentation/index_files/1560px-AddingAndConnectingPlugIns.png

1.75 MB

‎documentation/index_files/1600px-AggregatedMIDIPorts.png

1.75 MB

‎documentation/index_files/1600px-DUOX_PedalboardView.png

1.84 MB

‎documentation/index_files/1600px-DUO_PedalboardView.png

1.82 MB

‎documentation/index_files/1600px-SeparatedMIDIPorts.png

1.77 MB

‎documentation/index_files/200px-AdvancedAssignSettings.png

5.26 KB

‎documentation/index_files/225px-ManageCVPortsButton.png

11.7 KB

‎documentation/index_files/225px-SnapshotsButton.png

3.35 KB

‎documentation/index_files/300px-AdvancedAssignSettings.png

8.61 KB

‎documentation/index_files/300px-LabelCV.png

125 KB

‎documentation/index_files/300px-ManageCVPortsButton.png

15.4 KB

‎documentation/index_files/450px-LabelCV.png

247 KB

‎documentation/index_files/500px-AssigmentToMIDIController.png

35.8 KB

‎documentation/index_files/500px-AssignmentsWindow.png

21.1 KB

‎documentation/index_files/500px-CVPlugins.png

104 KB

‎documentation/index_files/500px-DUOX_AssignToCV.png

36.9 KB

‎documentation/index_files/500px-InternalCV.png

22.3 KB

‎documentation/index_files/500px-LoadManageSnapshots.png

47.1 KB

‎documentation/index_files/500px-MIDIPorts.png

28.9 KB

‎documentation/index_files/500px-NoCV.png

48.6 KB

‎documentation/index_files/500px-RemovingAssignment.png

22.1 KB

‎documentation/index_files/50px-PedalboardLibraryIcon.png

4.86 KB

‎documentation/index_files/750px-AssigmentToMIDIController.png

57.9 KB

‎documentation/index_files/750px-AssignmentsWindow.png

32.9 KB

‎documentation/index_files/750px-CVPlugins.png

210 KB

‎documentation/index_files/750px-DUOX_AssignToCV.png

64.6 KB

‎documentation/index_files/750px-InternalCV.png

34.8 KB

‎documentation/index_files/750px-LoadManageSnapshots.png

82.6 KB

‎documentation/index_files/750px-MIDIPorts.png

47.9 KB

‎documentation/index_files/750px-NoCV.png

80.7 KB

‎documentation/index_files/750px-RemovingAssignment.png

34.2 KB

‎documentation/index_files/75px-PedalboardLibraryIcon.png

5.09 KB

‎documentation/index_files/780px-AddingAndConnectingPlugIns.png

431 KB

‎documentation/index_files/800px-AggregatedMIDIPorts.png

443 KB

‎documentation/index_files/800px-DUOX_PedalboardView.png

474 KB

‎documentation/index_files/800px-DUO_PedalboardView.png

473 KB

‎documentation/index_files/800px-SeparatedMIDIPorts.png

449 KB

‎documentation/index_files/800px-SnapshotsMenu.png

358 KB

‎documentation/index_files/AdvancedAssignSettings.png

24.4 KB

‎documentation/index_files/Duo-bypass-plugin.png

63.1 KB

‎documentation/index_files/Gui-11.png

296 KB

‎documentation/index_files/Gui-14.png

102 KB

‎documentation/index_files/Gui-17.png

121 KB

‎documentation/index_files/Gui-23.png

6.36 KB

‎documentation/index_files/Gui-4.png

198 KB

‎documentation/index_files/Gui-5.png

34.1 KB

‎documentation/index_files/Gui-add-bank.png

2.63 KB

‎documentation/index_files/Gui-assign.png

276 Bytes

‎documentation/index_files/Gui-banks.png

936 Bytes

‎documentation/index_files/Gui-delete.png

1.44 KB

‎documentation/index_files/Gui-info-2.png

1.24 KB

‎documentation/index_files/Gui-info.png

1.19 KB

‎documentation/index_files/Gui-midi-ports.png

3.4 KB

‎documentation/index_files/Gui-new-pedalboard.png

5.85 KB

‎documentation/index_files/Gui-pedalboards.png

692 Bytes

‎documentation/index_files/Gui-settgins.png

1.26 KB

‎documentation/index_files/Gui-trash.png

656 Bytes

‎documentation/index_files/LabelCV.png

413 KB

‎documentation/index_files/LoadManageSnapshots.png

101 KB

‎documentation/index_files/MIDIPorts.png

50.2 KB

‎documentation/index_files/PedalboardLibraryIcon.png

5.02 KB

‎documentation/index_files/SnapshotsButton.png

9.83 KB

‎documentation/index_files/SnapshotsMenu.png

932 KB

‎documentation/index_files/global-new.css

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
html, html * {
2+
color: rgb(183, 183, 183) !important;}
3+
*{border-color:#a4afaf !important;}
4+
5+
input[type="button"]:hover, input[type="submit"]:not(.color):hover,
6+
input[type="reset"]:hover, button:hover, select:hover {
7+
color: #e9e9e9 !important;
8+
background-color: #303030 !important;
9+
}
10+
11+
html > body[class] a,html > body[class] a[class] {
12+
color: #6091c1 !important;
13+
}
14+
a, a[class] {
15+
color: #6091c1 !important;
16+
}
17+
html > body svg[class] {
18+
fill: rgb(183, 183, 183);
19+
}
20+
html > body svg {
21+
fill: rgb(183, 183, 183);
22+
}
23+
li {
24+
color: #004db3 !important;
25+
}
26+
27+
tr {
28+
color: #653d3d !important;
29+
}
30+
31+
cite {
32+
color: #268 !important;
33+
}
34+
35+
input {
36+
color: #257 !important;
37+
}
38+
39+
em {
40+
color: #DEF !important;
41+
}
42+
43+
ul {
44+
color: #650000 !important;
45+
}
46+
47+
nobr {
48+
color: #4a0505 !important;
49+
}
50+
51+
52+
strong {
53+
color: #9CC !important;
54+
}
55+
56+
57+
b {
58+
color: #7AF !important;
59+
}
60+
61+
a:hover, a:hover *, a:visited:hover, a:visited:hover *, span[onclick]:hover, div[onclick]:hover,
62+
[role="link"]:hover, [role="link"]:hover *, [role="button"]:hover *, [role="menuitem"]:hover, [role="menuitem"]:hover *, .link:hover, .link:hover * {
63+
color: #2a3bb1 !important;
64+
background-color: #0000009c !important;
65+
}
66+
67+
a:visited, a:visited * {
68+
color: #607069 !important
69+
}
70+
71+
a.highlight, a.highlight *, a.active, a.active *, .selected, .selected *, [href="#"] {
72+
color: #DDD !important;
73+
font-weight: bold !important
74+
}
75+
76+
textarea, i, td {
77+
color: #ACE !important;
78+
/* text-shadow: -1px -1px #000, 1px -1px #000, -1px 1px #000, 1px 1px #000 !important; */
79+
}
80+
/* Removed selection color
81+
::-moz-selection {
82+
color: #0FF !important;
83+
background-color: #333 !important;
84+
}
85+
86+
::selection {
87+
color: #0FF !important;
88+
background-color: #333 !important;
89+
}
90+
91+
::-webkit-selection {
92+
color: #0FF !important;
93+
background-color: #333 !important;
94+
}
95+
*/
96+
97+
abbr, progress, time, label, .date {
98+
color: #CDEFC2 !important;
99+
}
100+
101+
mark, code, pre, blockquote, [class*="quote"], td[style*="inset"][class="alt2"] {
102+
background-color: #00090F !important;
103+
}
104+
105+
/* Removed because dropdown icons were having black background unnecessarily.
106+
nav, menu, html body [class*="open"], html body [id*="Dropdown"], html body [id*="dropdown"], html body [class*="Dropdown"],
107+
html body [class*="dropdown"], html body [id*="menu"]:not(SELECT), html body [class*="menu"]:NOT(SELECT), html body [class*="tooltip"],
108+
html body [class*="popup"], html body [id*="popup"], html body [class*="note"], html body [class*="detail"], html body [class*="description"] {
109+
background-color: #232323 !important;
110+
}
111+
*/
112+
113+
114+
[onclick]:hover, [ondblclick]:hover, [onmousedown]:hover {
115+
color: #FEFF97 !important
116+
}

‎documentation/index_files/gnu-fdl.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2+
<html><head>
3+
<title>404 Not Found</title>
4+
</head><body>
5+
<h1>Not Found</h1>
6+
<p>The requested URL was not found on this server.</p>
7+
</body></html>

‎documentation/index_files/load.css

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎documentation/index_files/load_002.css

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎documentation/index_files/universal.css

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/*html {
2+
background-color: #252525 !important;
3+
background-image: none !important;
4+
}*/
5+
::-webkit-scrollbar {
6+
width: 7px;
7+
height: 7px;
8+
}
9+
::-webkit-scrollbar-button {
10+
width: 0px;
11+
height: 0px;
12+
}
13+
::-webkit-scrollbar-thumb {
14+
background: #525252;
15+
border: 0px none #ffffff;
16+
border-radius: 50px;
17+
}
18+
::-webkit-scrollbar-thumb:hover {
19+
background: #4c4c4c;
20+
}
21+
::-webkit-scrollbar-thumb:active {
22+
background: #404040;
23+
}
24+
::-webkit-scrollbar-track {
25+
background: #272727;
26+
border: 0px dashed #ffffff;
27+
border-radius: 22px;
28+
}
29+
::-webkit-scrollbar-corner {
30+
background: transparent;
31+
}

‎live-welcome/Makefile

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
OBJECTS = welcome.cpp.o
33
OBJECTS += src/AudioDiscovery.cpp.o
44
OBJECTS += src/KioskTabs.cpp.o
5+
OBJECTS += src/Utils.cpp.o
56
OBJECTS += src/moc_KioskSettingsPopup.cpp.o
67
OBJECTS += src/moc_KioskWindow.cpp.o
78
# OBJECTS += moc_welcome.cpp.o
@@ -54,6 +55,9 @@ src/AudioDiscovery.cpp.o: src/AudioDiscovery.cpp src/AudioDiscovery.hpp
5455
src/KioskTabs.cpp.o: src/KioskTabs.cpp src/KioskTabs.hpp src/KioskAbout.hpp resources/watermark.txt
5556
$(CXX) $< -c $(KF5_CFLAGS) $(QT5_CFLAGS) $(CXXFLAGS) -o $@
5657

58+
src/Utils.cpp.o: src/Utils.cpp src/Utils.hpp
59+
$(CXX) $< -c $(KF5_CFLAGS) $(QT5_CFLAGS) $(CXXFLAGS) -o $@
60+
5761
src/moc_%.cpp.o: src/moc_%.cpp
5862
$(CXX) $< -c $(KF5_CFLAGS) $(QT5_CFLAGS) $(CXXFLAGS) -o $@
5963

‎live-welcome/src/KioskTabs.cpp

+18-2
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,39 @@
55

66
// #include <QtWebEngineWidgets/QWebEngineSettings>
77

8-
#include <KParts/BrowserExtension>
8+
#include <QtCore/QDir>
9+
#include <QtCore/QFile>
10+
11+
// #include <KParts/BrowserExtension>
912
#include <KParts/ReadWritePart>
1013
#include <KService/KService>
1114

15+
#include <dlfcn.h>
16+
1217
#include "KioskAbout.hpp"
18+
#include "Utils.hpp"
19+
1320
static const char* const initial_html = "<html><body><style>body { background: black url(data:image/png;base64,"
1421
#include "../resources/watermark.txt"
1522
") no-repeat scroll calc(100vw - 506px) calc(100vh - 145px) }</style></body></html>";
1623

1724
KioskTabs::KioskTabs(QWidget* const parent)
1825
: QTabWidget(parent),
1926
fileBrowser(nullptr),
20-
webBrowser(new QWebEngineView(this))
27+
webBrowser(new QWebEngineView(this)),
28+
documentation(nullptr)
2129
{
2230
webBrowser->setHtml(initial_html);
2331
addTab(webBrowser, "Pedalboard");
2432

33+
QString documentationPath(findDocumentation());
34+
if (!documentationPath.isEmpty())
35+
{
36+
documentation = new QWebEngineView(this);
37+
documentation->setUrl(QUrl("file://" + documentationPath));
38+
addTab(documentation, "Documentation");
39+
}
40+
2541
#if 0
2642
if (const KService::Ptr service = KService::serviceByDesktopName("okular_part"))
2743
{

‎live-welcome/src/KioskTabs.hpp

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ class KioskTabs : public QTabWidget
1111
{
1212
KParts::BrowserExtension* fileBrowser;
1313
QWebEngineView* webBrowser;
14+
QWebEngineView* documentation;
1415

1516
public:
1617
explicit KioskTabs(QWidget* const parent);

‎live-welcome/src/KioskWindow.hpp

+1-40
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33

44
#pragma once
55

6-
#include <QtCore/QDir>
7-
#include <QtCore/QFile>
86
#include <QtCore/QProcess>
97
#include <QtCore/QTimer>
108
#include <QtGui/QKeyEvent>
@@ -15,44 +13,7 @@
1513
#include "KioskTabs.hpp"
1614
#include "KioskSettingsPopup.hpp"
1715

18-
#include <dlfcn.h>
19-
20-
static QString getExecutableFile();
21-
static QString getExecutableFile()
22-
{
23-
struct DLAddrReader
24-
{
25-
static QString getFilename()
26-
{
27-
Dl_info exeInfo;
28-
void* localSymbol = (void*)getExecutableFile;
29-
dladdr(localSymbol, &exeInfo);
30-
return QString(exeInfo.dli_fname);
31-
}
32-
};
33-
34-
static QString filename(DLAddrReader::getFilename());
35-
return filename;
36-
}
37-
38-
static QString findStartScript()
39-
{
40-
QFileInfo exe(getExecutableFile());
41-
QDir dir(exe.dir());
42-
43-
printf("dir is %s\n", dir.absolutePath().toUtf8().constData());
44-
45-
if (dir.exists("start.sh"))
46-
return dir.filePath("start.sh");
47-
48-
dir.cdUp();
49-
dir.cd("mod-os");
50-
51-
if (dir.exists("start.sh"))
52-
return dir.filePath("start.sh");
53-
54-
return QString();
55-
}
16+
#include "Utils.hpp"
5617

5718
class KioskWindow : public QMainWindow
5819
{

‎live-welcome/src/Utils.cpp

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/*
2+
*/
3+
4+
#include "Utils.hpp"
5+
6+
#include <QtCore/QDir>
7+
#include <QtCore/QFile>
8+
9+
#include <dlfcn.h>
10+
11+
static QString getExecutableFile();
12+
static QString getExecutableFile()
13+
{
14+
struct DLAddrReader
15+
{
16+
static QString getFilename()
17+
{
18+
Dl_info exeInfo;
19+
void* localSymbol = (void*)getExecutableFile;
20+
dladdr(localSymbol, &exeInfo);
21+
return QString(exeInfo.dli_fname);
22+
}
23+
};
24+
25+
static QString filename(DLAddrReader::getFilename());
26+
return filename;
27+
}
28+
29+
QString findDocumentation()
30+
{
31+
QFileInfo exe(getExecutableFile());
32+
QDir dir(exe.dir());
33+
34+
printf("dir is %s\n", dir.absolutePath().toUtf8().constData());
35+
36+
if (dir.exists("documentation"))
37+
return dir.absoluteFilePath("documentation/index.html");
38+
39+
dir.cdUp();
40+
41+
if (dir.exists("documentation"))
42+
return dir.absoluteFilePath("documentation/index.html");
43+
44+
return QString();
45+
}
46+
47+
QString findStartScript()
48+
{
49+
QFileInfo exe(getExecutableFile());
50+
QDir dir(exe.dir());
51+
52+
printf("dir is %s\n", dir.absolutePath().toUtf8().constData());
53+
54+
if (dir.exists("start.sh"))
55+
return dir.filePath("start.sh");
56+
57+
dir.cdUp();
58+
dir.cd("mod-os");
59+
60+
if (dir.exists("start.sh"))
61+
return dir.filePath("start.sh");
62+
63+
return QString();
64+
}

‎live-welcome/src/Utils.hpp

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/*
2+
*/
3+
4+
#pragma once
5+
6+
#include <QtCore/QString>
7+
8+
QString findDocumentation();
9+
QString findStartScript();

0 commit comments

Comments
 (0)