From c7da820b5dfa9805b589371bf5091b1081306486 Mon Sep 17 00:00:00 2001 From: poncethecat Date: Fri, 18 Aug 2017 22:23:38 +0100 Subject: [PATCH] here --- docs/Gemfile | 3 + docs/Gemfile.lock | 216 ++++++++++++++++++++++++++++++++++ docs/_config.yml | 1 + docs/_layouts/layout.html | 66 +++++++++++ docs/_layouts/wikipage.html | 77 ++++++++++++ docs/assets/css/style.scss | 13 ++ docs/{README.md => index.md} | 5 + docs/wiki/Basic-usage.md | 42 +++++++ docs/wiki/Destinations.md | 44 +++++++ docs/wiki/Encoder-settings.md | 29 +++++ docs/wiki/Hotkeys.md | 23 ++++ docs/wiki/Settings.md | 23 ++++ docs/wiki/Tools.md | 34 ++++++ docs/wiki/index.md | 11 ++ 14 files changed, 587 insertions(+) create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/_layouts/layout.html create mode 100644 docs/_layouts/wikipage.html create mode 100644 docs/assets/css/style.scss rename docs/{README.md => index.md} (98%) create mode 100644 docs/wiki/Basic-usage.md create mode 100644 docs/wiki/Destinations.md create mode 100644 docs/wiki/Encoder-settings.md create mode 100644 docs/wiki/Hotkeys.md create mode 100644 docs/wiki/Settings.md create mode 100644 docs/wiki/Tools.md create mode 100644 docs/wiki/index.md diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..d35b615 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,3 @@ +source 'https://rubygems.org' + +gem "github-pages", group: :jekyll_plugins diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 0000000..9c69262 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,216 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.8) + i18n (~> 0.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.5.1) + public_suffix (~> 2.0, >= 2.0.2) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.12.2) + colorator (1.1.0) + ethon (0.10.1) + ffi (>= 1.3.0) + execjs (2.7.0) + faraday (0.13.0) + multipart-post (>= 1.2, < 3) + ffi (1.9.18) + forwardable-extended (2.6.0) + gemoji (3.0.0) + github-pages (155) + activesupport (= 4.2.8) + github-pages-health-check (= 1.3.5) + jekyll (= 3.5.2) + jekyll-avatar (= 0.4.2) + jekyll-coffeescript (= 1.0.1) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.9.2) + jekyll-gist (= 1.4.1) + jekyll-github-metadata (= 2.8.0) + jekyll-mentions (= 1.2.0) + jekyll-optional-front-matter (= 0.2.0) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.1.0) + jekyll-redirect-from (= 0.12.1) + jekyll-relative-links (= 0.4.1) + jekyll-sass-converter (= 1.5.0) + jekyll-seo-tag (= 2.2.3) + jekyll-sitemap (= 1.0.0) + jekyll-swiss (= 0.4.0) + jekyll-theme-architect (= 0.1.0) + jekyll-theme-cayman (= 0.1.0) + jekyll-theme-dinky (= 0.1.0) + jekyll-theme-hacker (= 0.1.0) + jekyll-theme-leap-day (= 0.1.0) + jekyll-theme-merlot (= 0.1.0) + jekyll-theme-midnight (= 0.1.0) + jekyll-theme-minimal (= 0.1.0) + jekyll-theme-modernist (= 0.1.0) + jekyll-theme-primer (= 0.5.0) + jekyll-theme-slate (= 0.1.0) + jekyll-theme-tactile (= 0.1.0) + jekyll-theme-time-machine (= 0.1.0) + jekyll-titles-from-headings (= 0.4.0) + jemoji (= 0.8.0) + kramdown (= 1.13.2) + liquid (= 4.0.0) + listen (= 3.0.6) + mercenary (~> 0.3) + minima (= 2.1.1) + rouge (= 1.11.1) + terminal-table (~> 1.4) + github-pages-health-check (1.3.5) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 2.0) + typhoeus (~> 0.7) + html-pipeline (2.7.0) + activesupport (>= 2) + nokogiri (>= 1.4) + i18n (0.8.6) + jekyll (3.5.2) + addressable (~> 2.4) + colorator (~> 1.0) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-avatar (0.4.2) + jekyll (~> 3.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.9.2) + jekyll (~> 3.3) + jekyll-gist (1.4.1) + octokit (~> 4.2) + jekyll-github-metadata (2.8.0) + jekyll (~> 3.1) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.2.0) + activesupport (~> 4.0) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-optional-front-matter (0.2.0) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.1.0) + jekyll (~> 3.0) + jekyll-redirect-from (0.12.1) + jekyll (~> 3.3) + jekyll-relative-links (0.4.1) + jekyll (~> 3.3) + jekyll-sass-converter (1.5.0) + sass (~> 3.4) + jekyll-seo-tag (2.2.3) + jekyll (~> 3.3) + jekyll-sitemap (1.0.0) + jekyll (~> 3.3) + jekyll-swiss (0.4.0) + jekyll-theme-architect (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.2) + jekyll-theme-slate (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.0) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.4.0) + jekyll (~> 3.3) + jekyll-watch (1.5.0) + listen (~> 3.0, < 3.1) + jemoji (0.8.0) + activesupport (~> 4.0) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + kramdown (1.13.2) + liquid (4.0.0) + listen (3.0.6) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9.7) + mercenary (0.3.6) + mini_portile2 (2.2.0) + minima (2.1.1) + jekyll (~> 3.3) + minitest (5.10.3) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.8.0) + mini_portile2 (~> 2.2.0) + octokit (4.7.0) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.14.0) + forwardable-extended (~> 2.6) + public_suffix (2.0.5) + rb-fsevent (0.10.2) + rb-inotify (0.9.10) + ffi (>= 0.5.0, < 2) + rouge (1.11.1) + safe_yaml (1.0.4) + sass (3.5.1) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.1) + addressable (>= 2.3.5, < 2.6) + faraday (~> 0.8, < 1.0) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.3) + thread_safe (~> 0.1) + unicode-display_width (1.3.0) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + +BUNDLED WITH + 1.15.3 diff --git a/docs/_config.yml b/docs/_config.yml index fff4ab9..c5bddac 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,2 @@ theme: jekyll-theme-minimal +categories: [wiki] diff --git a/docs/_layouts/layout.html b/docs/_layouts/layout.html new file mode 100644 index 0000000..87645da --- /dev/null +++ b/docs/_layouts/layout.html @@ -0,0 +1,66 @@ + + + + + + +{% seo %} + + + + + + +
+
+

{{ site.title | default: site.github.repository_name }}

+

{{ site.description | default: site.github.project_tagline }}

+

Click here to visit the wiki

+ + {% if site.github.is_project_page %} +

View the Project on GitHub {{ github_name }}

+ {% endif %} + + {% if site.github.is_user_page %} +

View My GitHub Profile

+ {% endif %} + + {% if site.show_downloads %} + + {% endif %} +
+
+ + {{ content }} + +
+
+

Copyright (c) ArsenArsen 2017

+ {% if site.github.is_project_page %} +

This project is maintained by {{ site.github.owner_name }}

+ {% endif %} +

Hosted on GitHub Pages — Theme by orderedlist

+
+
+ + + + {% if site.google_analytics %} + + {% endif %} + + diff --git a/docs/_layouts/wikipage.html b/docs/_layouts/wikipage.html new file mode 100644 index 0000000..f0b485b --- /dev/null +++ b/docs/_layouts/wikipage.html @@ -0,0 +1,77 @@ + + + + + + +{% seo %} + + + + + + +
+
+

{{ site.title | default: site.github.repository_name }}

+

{{ site.description | default: site.github.project_tagline }}

+

Click here to go back to the homepage

+

Wiki Pages:

+
    + {% for page in site.pages %} + {% if page.categories contains 'wiki' %} +
  • {{ page.title }}
    • + {% endif %} + {% endfor %} +
+ + +
+
+ {% if site.github.is_project_page %} +

View the Project on GitHub {{ github_name }}

+ {% endif %} + + {% if site.github.is_user_page %} +

View My GitHub Profile

+ {% endif %} + + {% if site.show_downloads %} + + {% endif %} +
+
+ + {{ content }} + +
+
+

Copyright (c) ArsenArsen 2017

+ {% if site.github.is_project_page %} +

This project is maintained by {{ site.github.owner_name }}

+ {% endif %} +

Hosted on GitHub Pages — Theme by orderedlist

+
+
+ + + + {% if site.google_analytics %} + + {% endif %} + + diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss new file mode 100644 index 0000000..55a2807 --- /dev/null +++ b/docs/assets/css/style.scss @@ -0,0 +1,13 @@ +--- +--- + +@import "{{ site.theme }}"; + +/* stupid css killed the cat */ +header ul { + background: none; + border-radius: 0px; + border: 0px solid #e0e0e0; + + +} diff --git a/docs/README.md b/docs/index.md similarity index 98% rename from docs/README.md rename to docs/index.md index 2980699..6fc5f93 100644 --- a/docs/README.md +++ b/docs/index.md @@ -1,3 +1,8 @@ +--- +layout: layout +--- + + # **KShare** ## The free open source and cross platform screen sharing software ###### Inspired by [ShareX](https://getsharex.com) diff --git a/docs/wiki/Basic-usage.md b/docs/wiki/Basic-usage.md new file mode 100644 index 0000000..39c0e76 --- /dev/null +++ b/docs/wiki/Basic-usage.md @@ -0,0 +1,42 @@ +--- +title: Basic Usage +categories: [wiki] +layout: wikipage +--- +# Basic usage +When you start the app (with no arguments, discussed later) a window is popped up, and a tray icon is made. + +## The window +![](http://i.imgur.com/QOebwEM.png) + +The main window is a log window with a settings button. + +The menu bar has a `File` menu. It has two options, `Quit`, which exits ~~no need to press it :^)~~, and `About`, which contains licensing information: +![](http://i.imgur.com/4fVJb1w.png) + +There is a second menu, namely `Screenshot`. It has two options, area, and fullscreen capture. See below. + +The third, `Utility`, menu has the color picker in it. + +The third and final menu, `Recording`, has a start and stop recording button. + +## The tray +![](http://i.imgur.com/quVDzRN.png) + +The tray consists of a small, but nice, icon made by @BriannaFoxwell. Upon right clicking it you get the context menu shown above. The menu is rather simple, containing basic controls, and screenshotting options. +These options will be explained below. + +## Screenshotting options +### Area capture +Area capture takes a snapshot of the screen, and shows you a fullscreen editor for you to select a region in. This editor is explained in a section below. + +### Fullscreen capture +Fullscreen capture takes a snapshot of the entire screen and skips the editor part. Straight to the destination (explained later as well). + +### Active window capture +Takes the active window and uploads it straight to your destination of choice + +## Crop Editor +Crop Editor is a window you can use to select the area of the screen to upload. It consists of a grey overlay and a re-sizable rectangle. The rectangle is resized by holding the mouse buttons. When you let go of the button, a new selection will start replacing the old one. On the first press the same thing happens. +Press `Escape` to cancel, and `Return`, or `Enter` to submit. +Oh. And you can draw with right click. diff --git a/docs/wiki/Destinations.md b/docs/wiki/Destinations.md new file mode 100644 index 0000000..7325362 --- /dev/null +++ b/docs/wiki/Destinations.md @@ -0,0 +1,44 @@ +--- +title: Destinations +categories: [wiki] +layout: wikipage +--- +# Destinations +Destinations determine where your image goes + +There is a set of default uploaders, two, to be exact. +## Default uploaders: +### imgur +Uploads your image to imgur. +### clipboard +Copies your image to clipboard. + +## Custom uploaders +Placed into `CONFIG PATH/KShare/uploaders` +Eg: `$HOME/.config/KShare/uploaders` +All uploaders have to be `.uploader` files! +Custom uploaders can be added, and are made with JSON, and follow this template: +```js +{ + "name": "", // String, required + "desc": "", // String, optional + "method": "", // String, default: "POST", for now, just POST. Request more if you need them + "target": "", // URL, required + "format": "", // String, default: "json", can be `x-www-form-urlencoded` or `json` or `multipart-form-data`. Setting to `PLAIN` will make the body ignored and only the image sent. + "base64": false, // Optional, makes the data base64 + "body": {}, // A JSON object, where one of the nodes can be a string in the format `/ANYTHING/`. In `ANYTHING`, `%contenttype` is replaced with the image type and `%imagedata` is replaced with the image encoded with `imageformat`. Unless you use multipart, see below + "return": "" // Return pathspec. `|` copies the entire body, `.path.to.node` copies the value of the node. The dot IS IMPORTANT. Without it, nothing happens. If one of the nodes is not a string, the string is copied, if one is an object, recursion continues, if one is null, nothing is copied, otherwise the node is JSON stringified. Only supports JSON for now. +} +``` +Note that QJson does not support comments. +### Multipart +Multipart is obviously made out of multiple parts. The way you define a multipart body is: +```js +[ + { + "__HeaderName": "HeaderValue", // No limit here. Must start with __, which is removed later. + "body": { /* same way you define it for anything json */ } // Can be string. Strings matching `/.../` are processed same way as in a json field. + } +] +``` +This would go in the `body` field of the above JSON. diff --git a/docs/wiki/Encoder-settings.md b/docs/wiki/Encoder-settings.md new file mode 100644 index 0000000..f90a139 --- /dev/null +++ b/docs/wiki/Encoder-settings.md @@ -0,0 +1,29 @@ +--- +title: Encoder Settings +categories: [wiki] +layout: wikipage +--- +# Encoder settings +The encoders used can be customized to a high degree. Every encoder besides GIF has some settings. +![](http://i.imgur.com/O8nfeos.png) + +## Image encoder settings +The only option here is quality, by default it uses the default for the format you use. You can change it by unticking format default. [More info](http://doc.qt.io/qt-5/qpixmap.html#save) + +## Video encoder settings +The common settings are bitrate and GOP size. + +GOP Size is the size of a group of pictures. +Bitrate is the target bitrate. + +### h264/h265 +The H.26[45] MP4 codec has a few presets to choose. The recommended is to choose the slowest one you can cope with. +I recommend medium. + +CRF is the constant rate factor of this video stream, and again I recommend leaving the default value, `23`. + +### VP9 +VP9 is the WebP codec. Only option it has is lossless encoding, and you want it off, trust me. + +### GIF +GIF has no options. diff --git a/docs/wiki/Hotkeys.md b/docs/wiki/Hotkeys.md new file mode 100644 index 0000000..78f3c93 --- /dev/null +++ b/docs/wiki/Hotkeys.md @@ -0,0 +1,23 @@ +--- +title: Hotkeys +categories: [wiki] +layout: wikipage +--- +# Hotkeys +Hotkeys are configured in the settings UI. +![](http://i.imgur.com/esYoMWo.png) +Currently available hotkeys are: +## Fullscreen image +This bind lets you take a fullscreen image and upload it instantly. +## Area image +Equivalent to `Take area shot` and `Screenshot -> Area`. Takes a snapshot and opens the crop editor. +## Active window +Equivalent to `Active window` and `Screenshot -> Active window`. Takes a snapshot of the active window and sends it. +## Color picker +Opens the color picker +## Recording start/stop +Starts and stops recording + +## Editing hotkeys +All binds can be modified using by double clicking the hotkey name. +You can either type the hotkey in or press record and press the key combination you want on your keyboard diff --git a/docs/wiki/Settings.md b/docs/wiki/Settings.md new file mode 100644 index 0000000..bed6747 --- /dev/null +++ b/docs/wiki/Settings.md @@ -0,0 +1,23 @@ +--- +title: Settings +categories: [wiki] +layout: wikipage +--- +# Settings +## Destination +![](http://i.imgur.com/540REFK.png) +Select the active destination. Adding more is possible and explained it Custom Uploaders +**Default:** `imgur` +## Filename scheme +![](http://i.imgur.com/RHHEO3K.png) +Used to generate filenames. Extensions are placed in place of `%ext`. `%(DATE FORMAT)date` can be used to replace the date format with a format as specified by [this documentation page](http://doc.qt.io/qt-5/qdatetime.html#toString) +**Default:** `Screenshot %(yyyy-MM-dd HH:mm:ss)date.%ext` +## Delay before taking a screenshot +![](http://i.imgur.com/j0D7OqI.png) +Applies only to the buttons in menus. Hotkeys do not follow this rule. In seconds. Mostly used to let animations fade. +Min: `0.00` +Max: `99.99` +**Default:** `0.25` + +## Hotkeys +**Explained on a separate page.** diff --git a/docs/wiki/Tools.md b/docs/wiki/Tools.md new file mode 100644 index 0000000..60c5ec9 --- /dev/null +++ b/docs/wiki/Tools.md @@ -0,0 +1,34 @@ +--- +title: Tools +categories: [wiki] +layout: wikipage +--- +# Drawing +![](http://i.imgur.com/5nWhpqw.png) +On-screen drawing is pretty simple. Right click in the crop editor to show a pen selection tool. When you click on a pen it will stay selected until you press `Reset`. + +You can move drawings around by Ctrl+Dragging them + +## Available pens: +### Dot +Draws dots as you move your mouse +### Path +Makes a path where your mouse went. +### Blur +Allows you to set a rectangle to blur out. You'll get a settings popup upon selecting this pen. +### Straight line +A line between where you start and end dragging +### Text +Asks you to insert some text. +**WARNING:** Avoid pressing return and enter +### Rectangle +Drag to draw a rectangle +### Ellipse +Drag to draw an ellipse +### Eraser[](https://www.youtube.com/watch?v=OjGrcJ4lZCc) +Removes all items you drag your mouse over + +### Clear all drawings +Removes all drawings +### Reset +Allows you to choose a region to cut for the final result. diff --git a/docs/wiki/index.md b/docs/wiki/index.md new file mode 100644 index 0000000..741db33 --- /dev/null +++ b/docs/wiki/index.md @@ -0,0 +1,11 @@ +--- +title: Index +categories: [wiki] +layout: wikipage +--- + +# Welcome to the KShare wiki! +The cross platform screenshotting utility + +# Usage +See the [`Basic usage`](/wiki/Basic-Usage) page