From 2c20acb1981fc8fbd884dbece2a1115ca37732d2 Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Wed, 19 Sep 2018 23:35:43 +0200 Subject: Update documentation --- doc/Building.md | 28 ------------------------ doc/Building/QtWebEngine.md | 7 ++++++ doc/Building/smolbote.md | 30 +++++++++++++++++++++++++ doc/Profile.md | 17 --------------- doc/Session.md | 30 ------------------------- doc/Usage/CommandLine.md | 12 ++++++++++ doc/Usage/Configuration.md | 53 +++++++++++++++++++++++++++++++++++++++++++++ doc/Usage/Profile.md | 17 +++++++++++++++ doc/Usage/Session.md | 30 +++++++++++++++++++++++++ 9 files changed, 149 insertions(+), 75 deletions(-) delete mode 100644 doc/Building.md create mode 100644 doc/Building/QtWebEngine.md create mode 100644 doc/Building/smolbote.md delete mode 100644 doc/Profile.md delete mode 100644 doc/Session.md create mode 100644 doc/Usage/CommandLine.md create mode 100644 doc/Usage/Configuration.md create mode 100644 doc/Usage/Profile.md create mode 100644 doc/Usage/Session.md (limited to 'doc') diff --git a/doc/Building.md b/doc/Building.md deleted file mode 100644 index ab731dc..0000000 --- a/doc/Building.md +++ /dev/null @@ -1,28 +0,0 @@ -## Customizing -### Version - -### Configuration -Configuration values are set from defaults.h, which is generated from -defaults.h.{linux;win32}. - -## Building on Windows - -~~~ -set INSTALL_DIR="C:\projects\smolbote-install" -mkdir %INSTALL_DIR% - -mkdir C:\projects\smolbote-build -cd C:\projects\smolbote-build - -set QT="C:\Qt\5.11.0\msvc2017_64" -set BOOST_ROOT="C:\Libraries\boost_1_66_0" -set BOOST_LIBDIR="C:\Libraries\boost_1_66_0\lib64-msvc-14.1" -cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%INSTALL_DIR% -DCMAKE_PREFIX_PATH=%QT%;%BOOST_ROOT% -DBOOST_ROOT=%BOOST_ROOT% -DBOOST_LIBRARYDIR=%BOOST_LIBDIR% -DBoost_USE_STATIC_LIBS=On C:\projects\smolbote-hg -cmake --build . --target poi --config Release -cmake --build . --target install --config Release -cd %INSTALL_DIR% -C:\Qt\5.10.1\msvc2017_64\bin\windeployqt.exe bin\poi.exe - -7z a C:\projects\smolbote-hg\smolbote.7z %INSTALL_DIR% -~~~ - diff --git a/doc/Building/QtWebEngine.md b/doc/Building/QtWebEngine.md new file mode 100644 index 0000000..7d72dd6 --- /dev/null +++ b/doc/Building/QtWebEngine.md @@ -0,0 +1,7 @@ +- download qtwebengine + +~~~sh +mkdir build && cd build +qmake ../qtwebengine-version-source/qtwebengine.pro +make +~~~ diff --git a/doc/Building/smolbote.md b/doc/Building/smolbote.md new file mode 100644 index 0000000..e40132c --- /dev/null +++ b/doc/Building/smolbote.md @@ -0,0 +1,30 @@ +## Customizing +Set through vendor.cmake. + +### Configuration defaults + +### Version information +Building without git metadata requires the version be set in vendor.cmake. + + +## Building on Windows + +~~~sh +set INSTALL_DIR="C:\projects\smolbote-install" +mkdir %INSTALL_DIR% + +mkdir C:\projects\smolbote-build +cd C:\projects\smolbote-build + +set QT="C:\Qt\5.11.0\msvc2017_64" +set BOOST_ROOT="C:\Libraries\boost_1_66_0" +set BOOST_LIBDIR="C:\Libraries\boost_1_66_0\lib64-msvc-14.1" +cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%INSTALL_DIR% -DCMAKE_PREFIX_PATH=%QT%;%BOOST_ROOT% -DBOOST_ROOT=%BOOST_ROOT% -DBOOST_LIBRARYDIR=%BOOST_LIBDIR% -DBoost_USE_STATIC_LIBS=On C:\projects\smolbote-hg +cmake --build . --target poi --config Release +cmake --build . --target install --config Release +cd %INSTALL_DIR% +C:\Qt\5.10.1\msvc2017_64\bin\windeployqt.exe bin\poi.exe + +7z a C:\projects\smolbote-hg\smolbote.7z %INSTALL_DIR% +~~~ + diff --git a/doc/Profile.md b/doc/Profile.md deleted file mode 100644 index d205a86..0000000 --- a/doc/Profile.md +++ /dev/null @@ -1,17 +0,0 @@ -Profiles are read from profile.path - -## Settings - -- otr (defaults to true) - is this profile off-the-record -- name (defaults to the configuration file name) -- search (defaults to profile.search) - search engine url -- homepage (defaults to profile.homepage) -- newtab (defaults to profile.newtab) - -### Properties -Key is property name; value is property value - -### Attributes -see QWebEngineSetting::WebAttribute for list of IDs. -Key is attribute id; value is attribute value (true/false) - diff --git a/doc/Session.md b/doc/Session.md deleted file mode 100644 index 3018253..0000000 --- a/doc/Session.md +++ /dev/null @@ -1,30 +0,0 @@ -## Session format -A session is a single window, which contains a list of subwindows. - -Each subwindow has a profile (profile id), and a list of tabs. - -Each tab has a profile (profile id) and url. - -~~~json -{ - "subwindows": [ - { - "profile": "", - "tabs": [ - { - "profile": "", - "url": "" - }, - { - ... - } - ] - } - ] -} - -~~~ - -## --session -This command-line option causes the browser to load the specified json file. - diff --git a/doc/Usage/CommandLine.md b/doc/Usage/CommandLine.md new file mode 100644 index 0000000..1c532ce --- /dev/null +++ b/doc/Usage/CommandLine.md @@ -0,0 +1,12 @@ +## Command-line options + +### General +* `-h`, `--help`: Display this help. +* `-v`, `--version`: Display version information. +* `--build`: Display build branch and commit. +* `-c`, `--config`: Set configuration file. +* `--no-remote`: Don't check for other instances when starting. + +### Tweaking configuration +You can overwrite options at runtime using the option path as a command line +parameter. diff --git a/doc/Usage/Configuration.md b/doc/Usage/Configuration.md new file mode 100644 index 0000000..3bf55b9 --- /dev/null +++ b/doc/Usage/Configuration.md @@ -0,0 +1,53 @@ +## Configuration + +The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_. Most +settings are only loaded on launch. + +For a full list of settings, check `--help`. + +### Browser (group: browser) + +### Main Window (group: mainwindow) +A main window contains one or more subwindows. + +### Subwindow (group: window) +A subwindow contains multiple tabs and functions similarly to a tab group. + +### Navigation bar (group: navigation) +The navigation bar is the toolbar that holds the history, reload and home +buttons, as well as the address bar. It can be made movable through the +navigation.movable option. + +### Address bar (group: addressbar) + +### Filter (group: filter) + +### Plugins (group: plugins) +Plugins a way of extending smolbote's functionality using the Qt plugin system. +They are not to be confused with NPAPI/PPAPI or WebExtension plugins. + +To enable a plugin either copy it or symlink it in the plugins.path location, +or set its absolute path as the plugins.path. + +### Profiles (group: profile) +A Profile is a collection of settings, policies, scripts, cookies, cache and +history. Profiles can be used to isolate pages from each other. + +Each window has a default profile it uses when opening new tabs. This can be +set by the profile.default option, and can be changed from the window's menu. +Additionally, tabs can have their profiles individually changed from their page +menu. + +Because profiles store all their data separately, you can log in into the same +site with a different account from each profile. However, links opened into new +tabs will still use the subwindow's default profile. For example, you can set a +profile to hold login information for a site, but all new tabs opened from that +site would still be using the default off-the-record profile. + +Profile definitions are stored in the profiles.path location. To create a new +profile, create a profile-id.profile file in that location. + +### Bookmarks (group: bookmarks) + +### Downloads (group: downloads) + diff --git a/doc/Usage/Profile.md b/doc/Usage/Profile.md new file mode 100644 index 0000000..d205a86 --- /dev/null +++ b/doc/Usage/Profile.md @@ -0,0 +1,17 @@ +Profiles are read from profile.path + +## Settings + +- otr (defaults to true) - is this profile off-the-record +- name (defaults to the configuration file name) +- search (defaults to profile.search) - search engine url +- homepage (defaults to profile.homepage) +- newtab (defaults to profile.newtab) + +### Properties +Key is property name; value is property value + +### Attributes +see QWebEngineSetting::WebAttribute for list of IDs. +Key is attribute id; value is attribute value (true/false) + diff --git a/doc/Usage/Session.md b/doc/Usage/Session.md new file mode 100644 index 0000000..3018253 --- /dev/null +++ b/doc/Usage/Session.md @@ -0,0 +1,30 @@ +## Session format +A session is a single window, which contains a list of subwindows. + +Each subwindow has a profile (profile id), and a list of tabs. + +Each tab has a profile (profile id) and url. + +~~~json +{ + "subwindows": [ + { + "profile": "", + "tabs": [ + { + "profile": "", + "url": "" + }, + { + ... + } + ] + } + ] +} + +~~~ + +## --session +This command-line option causes the browser to load the specified json file. + -- cgit v1.2.1