From 704f7da9fc0d1854b685f516fba17a181fb24dfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Thu, 4 Jan 2018 15:16:53 +0100 Subject: [PATCH] Update documentation style --- README.md | 2 +- debian/copyright | 16 +- doc/config.qdocconf | 4 +- doc/html-styles.qdocconf | 4 +- doc/html-template.qdocconf | 47 ++- doc/images/main-logo.svg | 247 ++++++++++++ doc/license.qdoc | 2 +- doc/main.css | 794 +++++++++++++++++++++++++++++++++++++ 8 files changed, 1086 insertions(+), 30 deletions(-) create mode 100644 doc/images/main-logo.svg create mode 100644 doc/main.css diff --git a/README.md b/README.md index 50f15982..5b7ed2ec 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ In order to getting started with *guh* and find information you can take a look * A detailed documentation of the source code can be found in the - [guh | developer documentation](http://dev.guh.guru/). + [guh | developer documentation](https://developers.guh.io). ## Donate diff --git a/debian/copyright b/debian/copyright index 676da90c..21a47c23 100644 --- a/debian/copyright +++ b/debian/copyright @@ -1,7 +1,7 @@ Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: guhio Upstream-Contact: Simon Stürz -Copyright: 2014-2017, guh GmbH +Copyright: 2014-2018, guh GmbH Download: http://www.github.com/guh/guh Source: https://github.com/guh/guh.git @@ -27,27 +27,27 @@ Copyright: 2014-2017, Simon Stürz Files: tests/* License: GPL-2+ Copyright: 2014-2017, Simon Stürz - 2014, Michael Zanetti + 2014-2017, Michael Zanetti Files: translations/* License: LGPL-2.1 Copyright: 2016-2017, Simon Stürz Files: doc/* -License: LGPL-2.1 +License: GPL-2+ Copyright: 2015-2017, Simon Stürz - 2014, Michael Zanetti + 2014-2017, Michael Zanetti + 2017-2018, Georgi Yatsev Files: debian/* License: GPL-2+ Copyright: 2014-2017, Simon Stürz - 2014, Michael Zanetti + 2014-2017, Michael Zanetti Files: libguh/* License: LGPL-2.1 Copyright: 2014-2017, Simon Stürz - 2014 Carsten Schoenert - 2014, Michael Zanetti + 2014-2017, Michael Zanetti Files: libguh/coap/* License: LGPL-3 @@ -56,4 +56,4 @@ Copyright: 2016-2017, Simon Stürz Files: plugins/* License: LGPL-2.1 Copyright: 2014-2017, Simon Stürz - 2014, Michael Zanetti + 2014-2017, Michael Zanetti diff --git a/doc/config.qdocconf b/doc/config.qdocconf index 52571b84..cd96a88c 100644 --- a/doc/config.qdocconf +++ b/doc/config.qdocconf @@ -1,12 +1,12 @@ include(html-template.qdocconf) project = guh - developer -description = Gear up your Home! +description = Developer documentation! dita.metadata.default.author = Simon Stürz dita.metadata.default.permissions = all dita.metadata.default.publisher = guh GmbH -dita.metadata.default.copyryear = 2016 +dita.metadata.default.copyryear = 2018 dita.metadata.default.copyrholder = Simon Stürz dita.metadata.default.audience = programmer diff --git a/doc/html-styles.qdocconf b/doc/html-styles.qdocconf index d915f1a6..67171ab0 100644 --- a/doc/html-styles.qdocconf +++ b/doc/html-styles.qdocconf @@ -4,7 +4,7 @@ HTML.templatedir = . -HTML.stylesheets = style.css +HTML.stylesheets = main.css HTML.scripts = @@ -14,7 +14,7 @@ extraimages.HTML = images/logo.png \ # Include the style sheets and scripts used. HTML.headerstyles = \ - " \n" \ + " \n" \ " \n" \ " \n" \ " \n" \ diff --git a/doc/html-template.qdocconf b/doc/html-template.qdocconf index f9f0e8b6..2865b456 100644 --- a/doc/html-template.qdocconf +++ b/doc/html-template.qdocconf @@ -2,31 +2,46 @@ include(html-styles.qdocconf) HTML.postheader = \ "
\n" \ - "
\n" \ - " guh - Developer documentation\n" \ - "
\n" \ - "
\n" \ - "
    \n" \ - "
  • Home
    • \n" \ - "
  • Server
    • \n" \ - "
  • Lib
    • \n" \ - "
  • Plugins
    • \n" \ - "
  • API
    • \n" \ - "
  • Write Plugins
    • \n" + " \n" \ + "
\n" + HTML.postpostheader = \ - " \n" \ - "
\n" \ - "\n" \ "
\n" +HTML.prologue = \ + "
\n" HTML.footer = \ + "
\n" \ + "
\n" \ "
\n" \ "

\n" \ - " © 2013-2016 guh GmbH. All rights reserved. License" \ + " © 2013-2018 guh GmbH. All rights reserved. License"\n \ "

\n" \ - "
\n" \ + "\n" #HTML.footer = "" # Files not referenced in any qdoc file. diff --git a/doc/images/main-logo.svg b/doc/images/main-logo.svg new file mode 100644 index 00000000..a5503abe --- /dev/null +++ b/doc/images/main-logo.svg @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/license.qdoc b/doc/license.qdoc index 2fb8157a..3b0b1274 100644 --- a/doc/license.qdoc +++ b/doc/license.qdoc @@ -3,7 +3,7 @@ \title License \brief The license agreement of guh - Copyright 2013-2016 Simon Stürz . + Copyright 2013-2018 Simon Stürz . \section1 GNU GENERAL PUBLIC LICENSE diff --git a/doc/main.css b/doc/main.css new file mode 100644 index 00000000..377aeafe --- /dev/null +++ b/doc/main.css @@ -0,0 +1,794 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * * + * Copyright (C) 2017 Georgi Yatsev * + * * + * Permission is hereby granted, free of charge, to any person obtaining a copy * + * of this software and associated documentation files (the "Software"), to deal * + * in the Software without restriction, including without limitation the rights * + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included in all * + * copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * + * SOFTWARE. * + * * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ +/* QT Creator Theme */ +/* http://meyerweb.com/eric/tools/css/reset/ + v2.0 | 20110126 + License: none (public domain) +*/ +html, body, div, span, applet, object, iframe, +h1, h2, h3, h4, h5, h6, p, blockquote, pre, +a, abbr, acronym, address, big, cite, code, +del, dfn, em, img, ins, kbd, q, s, samp, +small, strike, strong, sub, sup, tt, var, +b, u, i, center, +dl, dt, dd, ol, ul, li, +fieldset, form, label, legend, +table, caption, tbody, tfoot, thead, tr, th, td, +article, aside, canvas, details, embed, +figure, figcaption, footer, header, hgroup, +menu, nav, output, ruby, section, summary, +time, mark, audio, video { + margin: 0; + padding: 0; + border: 0; + font-size: 100%; + font: inherit; + vertical-align: baseline; } + +/* HTML5 display-role reset for older browsers */ +article, aside, details, figcaption, figure, +footer, header, hgroup, menu, nav, section { + display: block; } + +body { + line-height: 1.5; + background: white; } + +ol, ul { + list-style: none; } + +blockquote, q { + quotes: none; } + +blockquote:before, blockquote:after, +q:before, q:after { + content: ''; + content: none; } + +table { + border-collapse: collapse; + border-spacing: 0; } + +/** + * modified version of normalize.css 3.0.2 + * http://necolas.github.io/normalize.css/ + */ +html { + font-family: sans-serif; + -ms-text-size-adjust: 100%; + -webkit-text-size-adjust: 100%; + box-sizing: border-box; + -webkit-tap-highlight-color: rgba(0, 0, 0, 0); + position: relative; + min-height: 100%; } + +audio, +canvas, +progress, +video { + display: inline-block; + vertical-align: baseline; } + +audio:not([controls]) { + display: none; + height: 0; } + +[hidden], +template { + display: none; } + +a { + background-color: transparent; } + +a:active, +a:hover { + outline: 0; } + +abbr[title] { + border-bottom: 1px dotted; } + +b, +strong { + font-weight: bold; } + +dfn, +i, em { + font-style: italic; } + +mark { + background: #ff0; + color: #000; } + +small { + font-size: 80%; } + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; } + +sup { + top: -0.5em; } + +sub { + bottom: -0.25em; } + +img { + border: 0; } + +svg:not(:root) { + overflow: hidden; } + +hr { + box-sizing: content-box; + height: 0; } + +pre { + overflow: auto; } + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; } + +button, +input, +optgroup, +select, +textarea { + color: inherit; + font: inherit; + margin: 0; } + +button { + overflow: visible; } + +button, +select { + text-transform: none; } + +button, +html input[type="button"], +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; + cursor: pointer; } + +button[disabled], +html input[disabled] { + cursor: default; } + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; } + +input { + line-height: normal; } + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; + padding: 0; } + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; } + +input[type="search"] { + -webkit-appearance: textfield; + box-sizing: content-box; } + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; } + +textarea { + overflow: auto; } + +optgroup { + font-weight: bold; } + +a { + /* 1 */ + background-color: transparent; + /* 2 */ + -webkit-text-decoration-skip: objects; } + +a:active, +a:hover { + outline: 0; } + +a { + color: #676767; + text-decoration: none; + cursor: pointer; } + +a:hover { + color: #57baae; + text-decoration: underline; } + +abbr[title] { + border-bottom: none; + text-decoration: underline; + text-decoration: underline dotted; } + +b, +strong { + font-weight: inherit; } + +b, +strong { + font-weight: bolder; } + +:not(pre) > code, +:not(pre) > kbd, +:not(pre) > samp { + /* 1 */ + font-size: 0.875rem; + /* 2 */ + font-family: Consolas, monaco, monospace; + /* 3 */ + color: #d63843; + white-space: nowrap; + padding: 2px 6px; + background: #efefef; } + +/* + * Emphasize + */ +em { + color: #d63843; } + +/* + * Insert + */ +ins { + background: #efefef; + color: #676767; + text-decoration: none; } + +mark { + background: #efefef; + color: #676767; } + +q { + font-style: italic; } + +small { + font-size: 80%; } + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; } + +sup { + top: -0.5em; } + +sub { + bottom: -0.25em; } + +audio, +canvas, +iframe, +img, +svg, +video { + vertical-align: middle; } + +audio, +canvas, +img, +video { + max-width: 100%; + height: auto; + box-sizing: border-box; } + +img { + border-style: none; } + +svg:not(:root) { + overflow: hidden; } + +p, +ul, +ol, +dl, +pre, +address, +fieldset, +figure { + margin: 0 0 20px 0; } + +* + p, +* + ul, +* + ol, +* + dl, +* + pre, +* + address, +* + fieldset, +* + figure { + margin-top: 20px; } + +h1, +h2, +h3, +h4, +h5, +h6 { + margin: 0 0 20px 0; + font-family: "Ubuntu", Helvetica, "Helvetica Neue", Arial, sans-serif; + font-weight: normal; + color: #676767; + text-transform: none; } + +* + h1, +* + h2, +* + h3, +* + h4, +* + h5, +* + h6 { + margin-top: 40px; } + +h1 { + font-size: 2.625rem; + line-height: 1.2; } + +h2 { + font-size: 2rem; + line-height: 1.3; } + +h3 { + font-size: 1.5rem; + line-height: 1.5; } + +h4 { + font-size: 1.25rem; + line-height: 1.5; } + +h5 { + font-size: 16px; + line-height: 1.5; } + +h6 { + font-size: 0.875rem; + line-height: 1.5; } + +ul, +ol { + padding-left: 30px; } + +ul > li > ul, +ul > li > ol, +ol > li > ol, +ol > li > ul { + margin: 0; } + +dt { + font-weight: bold; } + +dd { + margin-left: 0; } + +hr { + box-sizing: content-box; + height: 0; + overflow: visible; + margin: 0 0 20px 0; + border: 0; + border-top: 1px solid #b7b7b7; } + +* + hr { + margin-top: 20px; } + +address { + font-style: normal; } + +blockquote { + margin: 0 0 20px 0; + font-size: 1.25rem; + line-height: 1.5; + font-style: italic; + color: #676767; } + +* + blockquote { + margin-top: 20px; } + +blockquote p:last-of-type { + margin-bottom: 0; } + +blockquote footer { + margin-top: 10px; + font-size: 0.875rem; + line-height: 1.5; + color: #676767; } + +blockquote footer::before { + content: "-- "; } + +pre { + font: 0.875rem / 1.5 Consolas, monaco, monospace; + color: #666; + -moz-tab-size: 4; + tab-size: 4; + overflow: auto; + padding: 10px; + border: 1px solid #d3d5d6; + border-radius: 3px; + background: white; } + +pre code { + font-family: Consolas, monaco, monospace; } + +::-moz-selection { + background: #57baae; + color: white; + text-shadow: none; } + +::selection { + background: #57baae; + color: white; + text-shadow: none; } + +article, +aside, +details, +figcaption, +figure, +footer, +header, +main, +nav, +section, +summary { + display: block; } + +progress { + vertical-align: baseline; } + +template, +[hidden] { + display: none; } + +iframe { + border: 0; } + +a, +area, +button, +input, +label, +select, +summary, +textarea { + touch-action: manipulation; } + +html { + color: #676767; + font-family: "Ubuntu", Arial, Helvetica, sans-serif; + background: white; } + +.header { + overflow: auto; + height: auto; + width: 100%; + z-index: 5; } + +code { + padding-left: 5px; } + +li { + display: list-item; + text-align: -webkit-match-parent; + text-align: justify; } + +table { + border: 1px solid #d3d5d6; + border-collapse: collapse; + border-spacing: 0; + margin-bottom: 5px; + width: 100%; } + table td { + padding: 5px 20px; + line-height: 1.5; + border: 1px solid #d3d5d6; } + +div.table { + overflow: auto; + -webkit-overflow-scrolling: touch; } + +.rightAlign { + padding: 3px 5px 3px 10px; + text-align: right; } + +.guh-navbar { + display: -ms-flexbox; + display: -webkit-flex; + display: flex; + position: fixed; + z-index: 10; + width: 100%; + min-height: 100px; + background: #efefef; + border-bottom: 1px solid #dbdbdb; } + +.guh-margin { + margin-bottom: 20px; } + +.guh-logo { + display: -ms-flexbox; + display: -webkit-flex; + display: flex; + -ms-flex-pack: center; + -webkit-justify-content: center; + justify-content: center; + -ms-flex-align: center; + -webkit-align-items: center; + align-items: center; + box-sizing: border-box; + min-height: 100px; + padding: 0 15px; + font-size: 14px; + text-decoration: none; + margin: 0 45px; } + +.guh-main-logo { + height: 85px; + min-height: 85px; + max-height: 85px; } + +.guh-navbar-center { + display: -ms-flexbox; + display: -webkit-flex; + display: flex; + -ms-flex-align: center; + -webkit-align-items: center; + align-items: center; } + .guh-navbar-center:only-child { + -ms-flex-wrap: wrap; + -webkit-flex-wrap: wrap; + flex-wrap: wrap; + margin-left: auto; + margin-right: auto; + position: relative; } + +.guh-navbar-nav { + display: -ms-flexbox; + display: -webkit-flex; + display: flex; + margin: 0; + padding: 0; + list-style: none; } + .guh-navbar-nav li { + text-overflow: ellipsis; + /* Required for text-overflow to do anything */ + white-space: nowrap; + overflow: hidden; } + .guh-navbar-nav li:after { + content: ""; + display: inline-block; + width: 100%; } + .guh-navbar-nav > li > a { + color: #676767; + font-size: 1.3rem; + display: -ms-flexbox; + display: -webkit-flex; + display: flex; + -ms-flex-pack: center; + -webkit-justify-content: center; + justify-content: center; + -ms-flex-align: center; + -webkit-align-items: center; + align-items: center; + box-sizing: border-box; + min-height: 100px; + padding: 0 15px; + text-decoration: none; } + +div.header + li { + color: #408a83; + font-size: 1.3rem; + display: -ms-flexbox; + display: -webkit-flex; + display: flex; + -ms-flex-pack: center; + -webkit-justify-content: center; + justify-content: center; + -ms-flex-align: center; + -webkit-align-items: center; + align-items: center; + box-sizing: border-box; + min-height: 100px; + padding: 35px; + text-decoration: none; + z-index: 10; + position: fixed; + list-style: none; + text-align: center; } + +.guh-navbar-center-left, .guh-navbar-center-right { + position: absolute; + top: 0; } + .guh-navbar-center-left > *, .guh-navbar-center-right > * { + display: -ms-flexbox; + display: -webkit-flex; + display: flex; + -ms-flex-align: center; + -webkit-align-items: center; + align-items: center; } + +.guh-navbar-center-left { + right: 100%; } + +.guh-navbar-center-right { + left: 100%; } + +.content { + z-index: 0; + box-sizing: content-box; + max-width: 1200px; + margin-left: auto; + margin-right: auto; + padding: 10rem 3.3rem 10rem; + width: 100%; + position: relative; } + .content:before { + content: ''; + display: table; } + .content:after { + content: ''; + display: table; + clear: both; } + .content .sidebar { + position: fixed; + top: 100px; + left: 0; + bottom: 0; + background: white; + box-sizing: border-box; + width: 23.5% !important; + padding: 40px 40px 120px 40px; + border-right: 1px #d3d5d6 solid; + overflow: auto; } + .content .sidebar h3 { + text-align: center; + padding-bottom: 15px; + border-bottom: 1px #d3d5d6 solid; } + .content .sidebar h3 a { + color: #676767; } + .content .sidebar ul { + padding-left: 0; } + .content .context { + width: 70%; + margin: 0 auto; } + .content .context .small-subtitle:before { + content: ""; + display: inline-block; + position: relative; + top: calc(-0.1 * 1em); + vertical-align: middle; + height: .9em; + margin-right: 10px; + border-left: 5px solid rgba(211, 213, 214, 0.65); } + .content table { + vertical-align: initial; } + .content ul li { + line-height: 1.5; + position: relative; + padding-left: calc(1.5em + 10px); } + .content ul li::before { + content: ""; + position: absolute; + top: 0; + left: 0; + width: 1.5em; + height: 1.5em; + background-image: url('data:image/svg+xml;utf8,'); + background-repeat: no-repeat; + background-position: 50% 50%; + float: left; } + .content a { + text-decoration: none; + color: #57baae; + position: relative; } + .content a:hover { + color: #57baae; + text-decoration: none; } + .content a:before { + content: ""; + position: absolute; + width: 100%; + height: 1px; + bottom: 0; + left: 0; + background-color: #7cc09a; + visibility: hidden; + -webkit-transform: scaleX(0); + transform: scaleX(0); + -webkit-transition: all 0.3s ease-in-out 0s; + transition: all 0.3s ease-in-out 0s; } + .content a:hover:before { + visibility: visible; + -webkit-transform: scaleX(1); + transform: scaleX(1); } + +.centerAlign { + text-align: center; } + +pre { + border: 1px solid #676767; + background: #3a4055; + -moz-border-radius: 0.7em 0.7em 0.7em 0.7em; + -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em; + border-radius: 0.7em 0.7em 0.7em 0.7em; + margin: 0 1.5em 1em 1em; + padding: 1em 1em 1em 1em; + overflow-x: auto; + color: #d3d5d6; } + pre .operator { + color: white; } + pre .type { + color: #4f9d08; } + pre .keyword { + color: #ffff55; } + +span.type { + color: #408a83; } + +h2, h3.fn { + position: relative; } + h2:after, h3.fn:after { + position: absolute; + content: ''; + height: 1px; + bottom: -10px; + margin: 0 auto 0 0; + left: 0; + right: 0; + width: 20%; + background: #d3d5d6; } + +div.footer { + position: absolute; + bottom: 0; + left: 0; + width: 100%; + z-index: 5; + text-align: center; + background: #efefef; + padding: 60px; } + div.footer p { + padding: 0; + margin: 0; } + +@media screen and (max-width: 1440px) { + .content .context { + width: 50%; } } + +/*# sourceMappingURL=main.css.map */