Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/communication/front2daemon.html b/docs/book/communication/front2daemon.html
new file mode 100644
index 00000000..b67fed5d
--- /dev/null
+++ b/docs/book/communication/front2daemon.html
@@ -0,0 +1,330 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Communication between daemon to datastore
+Overview
+-
+
- Use GRPC for communication between daemon and datastore
+
-
+
- Daemon send array of command, and datastore will apply them +
- Daemon retrieves updates from datastore periodically for syncing +
+
GRPC APIs
+-
+
- Use Hashira service. See daemon overview. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/communication/overview.html b/docs/book/communication/overview.html
new file mode 100644
index 00000000..4748d9c0
--- /dev/null
+++ b/docs/book/communication/overview.html
@@ -0,0 +1,248 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Communication between front to daemon
+Overview
+-
+
- hashira uses GRPC for communication between front and daemon +
PC
+CLI and Daemon
+-
+
- CLI to Daemon
+
-
+
- Add a new task to Backlog +
- Change task's status +
- Show task list +
+ - Daemon to CLI
+
-
+
- None +
+
GUI and Daemon
+-
+
-
+
Assume to use Electron
+
+ -
+
GUI to daemon
+-
+
- Add a new task to Backlog, ToDo, Doing, Done +
- Change task's status +
- Show task list on each status +
- Show consume of each task +
+ -
+
Daemon to GUI
+-
+
- notify any update of tasks +
+ -
+
TODO: Show GUI picture
+
+
Android
+application and daemon
+-
+
-
+
GUI to Daemon
+-
+
- Add a new task to Backlog, ToDo, Doing, Done +
- Change task's status +
- Show task list on each status +
- Show consume of each task +
+ -
+
Daemon to GUI
+-
+
- Notify any update of tasks +
+ -
+
TODO: Show GUI picture
+
+
Widget and Daemon
+-
+
-
+
Widget to Daemon
+-
+
- Add a new task to Backlog +
- Change task's status to Done +
- Show task list +
+ -
+
Daemon to widget
+-
+
- Notify any update of tasks +
+ -
+
TODO: Show GUI picture
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/css/chrome.css b/docs/book/css/chrome.css
new file mode 100644
index 00000000..8b78255d
--- /dev/null
+++ b/docs/book/css/chrome.css
@@ -0,0 +1,606 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+@import 'variables.css';
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 3px 5px;
+ font-size: 14px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.no-js .sidebar,
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/docs/book/css/general.css b/docs/book/css/general.css
new file mode 100644
index 00000000..e7d20da7
--- /dev/null
+++ b/docs/book/css/general.css
@@ -0,0 +1,234 @@
+/* Base styles and content styles */
+
+@import 'variables.css';
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/docs/book/css/print.css b/docs/book/css/print.css
new file mode 100644
index 00000000..80ec3a54
--- /dev/null
+++ b/docs/book/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/docs/book/css/variables.css b/docs/book/css/variables.css
new file mode 100644
index 00000000..0da55e8c
--- /dev/null
+++ b/docs/book/css/variables.css
@@ -0,0 +1,279 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ --color-scheme: light;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/docs/book/daemon/entity.html b/docs/book/daemon/entity.html
new file mode 100644
index 00000000..401d38ba
--- /dev/null
+++ b/docs/book/daemon/entity.html
@@ -0,0 +1,281 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Communication
+-
+
- Use GRPC for communication between front and daemon +
- Use GRPC for communication between daemon and datastore +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/daemon/overview.html b/docs/book/daemon/overview.html
new file mode 100644
index 00000000..c07d69fb
--- /dev/null
+++ b/docs/book/daemon/overview.html
@@ -0,0 +1,339 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data entities for local document store
+-
+
-
+
Two data entities are declared for local document store.
+-
+
- Tasks +
- Priorities +
+ -
+
Refer proto file for latest data entity declaration.
+
+
Tasks
+-
+
- Tasks represents each ToDo items. +
message Task {
+ string id = 1;
+ string name = 2;
+ Place place = 3;
+ bool isDeleted = 4;
+}
+Priorities
+-
+
- Priorities represents priority of each task.
+
-
+
- Priorities are represented as its place and array of task ID. +
- The ID placed on lower index means higher priority. +
+
message Priority {
+ Place place = 1;
+ repeated string ids = 2;
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/elasticlunr.min.js b/docs/book/elasticlunr.min.js
new file mode 100644
index 00000000..94b20dd2
--- /dev/null
+++ b/docs/book/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Overview of Daemon's functionality
+-
+
- Daemon has responsibility for
+
-
+
- Receive requests from front end. +
- Caches commands and reflect them to local document store for working without network. +
- Send chunk of commands to datastore for syncing. +
- Receive chunk of data to sync with datastore. +
+
Caches data entities on local document store
+-
+
- Caches commands and reflect them to local document store for working without network.
+
-
+
- here is data entities for local document store +
+
Sync with datastore
+-
+
- Daemon has a document store to cache commands from front end, and store data from datastore. +
- Periodically, daemon tries to perform syncing local data with datastore.
+
-
+
- Send local commands, that are "not synced yet", to datastore. +
- Retrieve chunk of data. They are JSON formatted and represent "1 week of data", for example. +
- Daemon stores 10 weeks of data in local document store. +
+
GRPC API
+-
+
-
+
Hashira Service
+-
+
- send(array of command)
+
-
+
- sends specified commands. +
+ - retrieve(from, to (number of weeks)) array of task
+
-
+
- returns array of task with specified term. +
+
+ - send(array of command)
+
-
+
command and related enumeration
+
+
what (enum)
+| enum | remarks |
|---|---|
| new | create a new task |
| update | update state of a task |
command (structure)
+| field | type | remarks |
|---|---|---|
| what | enum of what | new, update, etc. |
| payload | string | JSON formatted string how to treat what. |
Command handling
+-
+
-
+
When daemon receives commands, cache them and return ok immediately.
+
+ -
+
If daemon is online, send cached commands to datastore.
+
+ -
+
When datastore receives commands and succeed to apply them, datastore sends notification to daemon.
+
+ -
+
At daemon receiving notification, retrieve chunk of data from datastore for syncing.
+
+ -
+
When daemon succeed to apply them, daemon sends notification to front end.
+
+ -
+
At front end receiving notification, retrieve chunk of data from daemon.
+
+ -
+
When front end succeed to retrieve chunk of data, render them.
+
+ -
+
If daemon is offline, postpone to send commands to datastore.
+-
+
- Instead, daemon applies the cached commands to local document store, +and send notification to front end as same as written above. +
+
":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/mark.min.js b/docs/book/mark.min.js
new file mode 100644
index 00000000..16362318
--- /dev/null
+++ b/docs/book/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of contents
+Summary
+-
+
- Introduction +
- Overview +
- Communication + + +
- Daemon
+
-
+
- Entity +
+ - DB tables +
- Prototype +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/print.html b/docs/book/print.html
new file mode 100644
index 00000000..3371c4f0
--- /dev/null
+++ b/docs/book/print.html
@@ -0,0 +1,612 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ hashira Design overview
+Functions of hashira on PC
+CLI and GUI
+-
+
- Add a new task and place it on Backlog +
- Change status of tasks to ToDo, Doing, and Done +
- Add interrupter task, place it on Doing directory +
- Show list of tasks on each status +
GUI specific
+-
+
- Show chart to indicate how long time spent to current task +
Functions of hashira on Android
+Application
+-
+
- Add a new task and place it on Backlog +
- Change status of tasks to ToDo, Doing, and Done +
- Add interrupter task, place it on Doing directory +
- Show list of tasks on each status +
Widget
+-
+
- Add a new task and place it on Backlog +
- Show list of tasks on Backlog +
- Show current task and how long time spent to the task +
Functions of Daemon
+-
+
- It is for making hashira work even there's no network +
- Daemon has database to cache the tasks and "commands"
+
-
+
- "commands" means a unit of modifications to tasks. +e.g) Add new task, move task to ToDo, and so on +
- "commands" are used to sync with datastore +
+ - If network is available, then sync registered or changed tasks with cloud +
Functions of datastore
+-
+
- It is assumed to place on cloud. it is for syncing data between devices +
- It accepts "commands" to add or modify tasks +
- Daemon can retrieve chunk of commands with from-to query to reflect datastore's update to local database +
Modules
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/prototype.html b/docs/book/prototype.html
new file mode 100644
index 00000000..253331c8
--- /dev/null
+++ b/docs/book/prototype.html
@@ -0,0 +1,253 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Table of contents
+Summary
+-
+
- Introduction +
- Overview +
- Communication + + +
- Daemon
+
-
+
- Entity +
+ - DB tables +
- Prototype +
hashira Design overview
+Functions of hashira on PC
+CLI and GUI
+-
+
- Add a new task and place it on Backlog +
- Change status of tasks to ToDo, Doing, and Done +
- Add interrupter task, place it on Doing directory +
- Show list of tasks on each status +
GUI specific
+-
+
- Show chart to indicate how long time spent to current task +
Functions of hashira on Android
+Application
+-
+
- Add a new task and place it on Backlog +
- Change status of tasks to ToDo, Doing, and Done +
- Add interrupter task, place it on Doing directory +
- Show list of tasks on each status +
Widget
+-
+
- Add a new task and place it on Backlog +
- Show list of tasks on Backlog +
- Show current task and how long time spent to the task +
Functions of Daemon
+-
+
- It is for making hashira work even there's no network +
- Daemon has database to cache the tasks and "commands"
+
-
+
- "commands" means a unit of modifications to tasks. +e.g) Add new task, move task to ToDo, and so on +
- "commands" are used to sync with datastore +
+ - If network is available, then sync registered or changed tasks with cloud +
Functions of datastore
+-
+
- It is assumed to place on cloud. it is for syncing data between devices +
- It accepts "commands" to add or modify tasks +
- Daemon can retrieve chunk of commands with from-to query to reflect datastore's update to local database +
Modules
+
Communication
+-
+
- Use GRPC for communication between front and daemon +
- Use GRPC for communication between daemon and datastore +
Communication between front to daemon
+Overview
+-
+
- hashira uses GRPC for communication between front and daemon +
PC
+CLI and Daemon
+-
+
- CLI to Daemon
+
-
+
- Add a new task to Backlog +
- Change task's status +
- Show task list +
+ - Daemon to CLI
+
-
+
- None +
+
GUI and Daemon
+-
+
-
+
Assume to use Electron
+
+ -
+
GUI to daemon
+-
+
- Add a new task to Backlog, ToDo, Doing, Done +
- Change task's status +
- Show task list on each status +
- Show consume of each task +
+ -
+
Daemon to GUI
+-
+
- notify any update of tasks +
+ -
+
TODO: Show GUI picture
+
+
Android
+application and daemon
+-
+
-
+
GUI to Daemon
+-
+
- Add a new task to Backlog, ToDo, Doing, Done +
- Change task's status +
- Show task list on each status +
- Show consume of each task +
+ -
+
Daemon to GUI
+-
+
- Notify any update of tasks +
+ -
+
TODO: Show GUI picture
+
+
Widget and Daemon
+-
+
-
+
Widget to Daemon
+-
+
- Add a new task to Backlog +
- Change task's status to Done +
- Show task list +
+ -
+
Daemon to widget
+-
+
- Notify any update of tasks +
+ -
+
TODO: Show GUI picture
+
+
Communication between daemon to datastore
+Overview
+-
+
- Use GRPC for communication between daemon and datastore
+
-
+
- Daemon send array of command, and datastore will apply them +
- Daemon retrieves updates from datastore periodically for syncing +
+
GRPC APIs
+-
+
- Use Hashira service. See daemon overview. +
Overview of Daemon's functionality
+-
+
- Daemon has responsibility for
+
-
+
- Receive requests from front end. +
- Caches commands and reflect them to local document store for working without network. +
- Send chunk of commands to datastore for syncing. +
- Receive chunk of data to sync with datastore. +
+
Caches data entities on local document store
+-
+
- Caches commands and reflect them to local document store for working without network.
+
-
+
- here is data entities for local document store +
+
Sync with datastore
+-
+
- Daemon has a document store to cache commands from front end, and store data from datastore. +
- Periodically, daemon tries to perform syncing local data with datastore.
+
-
+
- Send local commands, that are "not synced yet", to datastore. +
- Retrieve chunk of data. They are JSON formatted and represent "1 week of data", for example. +
- Daemon stores 10 weeks of data in local document store. +
+
GRPC API
+-
+
-
+
Hashira Service
+-
+
- send(array of command)
+
-
+
- sends specified commands. +
+ - retrieve(from, to (number of weeks)) array of task
+
-
+
- returns array of task with specified term. +
+
+ - send(array of command)
+
-
+
command and related enumeration
+
+
what (enum)
+| enum | remarks |
|---|---|
| new | create a new task |
| update | update state of a task |
command (structure)
+| field | type | remarks |
|---|---|---|
| what | enum of what | new, update, etc. |
| payload | string | JSON formatted string how to treat what. |
Command handling
+-
+
-
+
When daemon receives commands, cache them and return ok immediately.
+
+ -
+
If daemon is online, send cached commands to datastore.
+
+ -
+
When datastore receives commands and succeed to apply them, datastore sends notification to daemon.
+
+ -
+
At daemon receiving notification, retrieve chunk of data from datastore for syncing.
+
+ -
+
When daemon succeed to apply them, daemon sends notification to front end.
+
+ -
+
At front end receiving notification, retrieve chunk of data from daemon.
+
+ -
+
When front end succeed to retrieve chunk of data, render them.
+
+ -
+
If daemon is offline, postpone to send commands to datastore.
+-
+
- Instead, daemon applies the cached commands to local document store, +and send notification to front end as same as written above. +
+
Data entities for local document store
+-
+
-
+
Two data entities are declared for local document store.
+-
+
- Tasks +
- Priorities +
+ -
+
Refer proto file for latest data entity declaration.
+
+
Tasks
+-
+
- Tasks represents each ToDo items. +
message Task {
+ string id = 1;
+ string name = 2;
+ Place place = 3;
+ bool isDeleted = 4;
+}
+Priorities
+-
+
- Priorities represents priority of each task.
+
-
+
- Priorities are represented as its place and array of task ID. +
- The ID placed on lower index means higher priority. +
+
message Priority {
+ Place place = 1;
+ repeated string ids = 2;
+}
+Database tables
+User
+| column | type | remarks |
|---|---|---|
| user_id | number | primary key, non-null, unique |
| user_name | string | non-null, unique |
| password | string | non-null |
Task
+| column | type | remarks |
|---|---|---|
| task_id | number | primary key, non-null, unique |
| task_name | string | non-null |
| user_id | number | non-null |
| status_id | number | non-null |
| label_id | number | non-null |
| done_at | time | non-null |
-
+
- task represents tasks and its status. +
Status
+| column | type | remarks |
|---|---|---|
| status_id | number | primary key, non-null, unique |
| status_name | string | non-null, unique |
-
+
- status represents task's status. like "Backlog", "ToDo", "Doing" and "Done" will be inserted here. +
Consume
+| column | type | remarks |
|---|---|---|
| consume_id | number | primary key, non-null, unique |
| task_id | number | non-null |
| started_at | time | non-null |
| finished_at | time | non-null |
| consumed | time | non-null |
-
+
- consume represents how many times are consumed for specified task. +
Label
+| column | type | remarks |
|---|---|---|
| label_id | number | primary key, non-null, unique |
| label_name | string | non-null |
-
+
- label represents task's label. this is used to task classification. +
ER diagram
+
Prototype
+Here's design memorandum of hashira prototyping, for checking usability.
+Feature notice of prototype version
+-
+
- No performance/resource consideration +
- front end is for linux PC only
+
-
+
- CUI and GUI (may use astilectron) +
+ - No cloud syncing +
- No "Doing" time calculation +
- Daemon uses MySQL as DB +
Sequence of tweaking tasks
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/searcher.js b/docs/book/searcher.js
new file mode 100644
index 00000000..dc03e0a0
--- /dev/null
+++ b/docs/book/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prototype
+Here's design memorandum of hashira prototyping, for checking usability.
+Feature notice of prototype version
+-
+
- No performance/resource consideration +
- front end is for linux PC only
+
-
+
- CUI and GUI (may use astilectron) +
+ - No cloud syncing +
- No "Doing" time calculation +
- Daemon uses MySQL as DB +
Sequence of tweaking tasks
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/book/tomorrow-night.css b/docs/book/tomorrow-night.css
new file mode 100644
index 00000000..81fe276e
--- /dev/null
+++ b/docs/book/tomorrow-night.css
@@ -0,0 +1,102 @@
+/* Tomorrow Night Theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+
+/* Tomorrow Comment */
+.hljs-comment {
+ color: #969896;
+}
+
+/* Tomorrow Red */
+.hljs-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-regexp,
+.ruby .hljs-constant,
+.xml .hljs-tag .hljs-title,
+.xml .hljs-pi,
+.xml .hljs-doctype,
+.html .hljs-doctype,
+.css .hljs-id,
+.css .hljs-class,
+.css .hljs-pseudo {
+ color: #cc6666;
+}
+
+/* Tomorrow Orange */
+.hljs-number,
+.hljs-preprocessor,
+.hljs-pragma,
+.hljs-built_in,
+.hljs-literal,
+.hljs-params,
+.hljs-constant {
+ color: #de935f;
+}
+
+/* Tomorrow Yellow */
+.ruby .hljs-class .hljs-title,
+.css .hljs-rule .hljs-attribute {
+ color: #f0c674;
+}
+
+/* Tomorrow Green */
+.hljs-string,
+.hljs-value,
+.hljs-inheritance,
+.hljs-header,
+.hljs-name,
+.ruby .hljs-symbol,
+.xml .hljs-cdata {
+ color: #b5bd68;
+}
+
+/* Tomorrow Aqua */
+.hljs-title,
+.css .hljs-hexcolor {
+ color: #8abeb7;
+}
+
+/* Tomorrow Blue */
+.hljs-function,
+.python .hljs-decorator,
+.python .hljs-title,
+.ruby .hljs-function .hljs-title,
+.ruby .hljs-title .hljs-keyword,
+.perl .hljs-sub,
+.javascript .hljs-title,
+.coffeescript .hljs-title {
+ color: #81a2be;
+}
+
+/* Tomorrow Purple */
+.hljs-keyword,
+.javascript .hljs-function {
+ color: #b294bb;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #1d1f21;
+ color: #c5c8c6;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+ opacity: 0.5;
+}
+
+.hljs-addition {
+ color: #718c00;
+}
+
+.hljs-deletion {
+ color: #c82829;
+}
diff --git a/docs/communication/daemon2datastore.html b/docs/communication/daemon2datastore.html
deleted file mode 100644
index b5d28286..00000000
--- a/docs/communication/daemon2datastore.html
+++ /dev/null
@@ -1,330 +0,0 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Database tables
+User
+| column | type | remarks |
|---|---|---|
| user_id | number | primary key, non-null, unique |
| user_name | string | non-null, unique |
| password | string | non-null |
Task
+| column | type | remarks |
|---|---|---|
| task_id | number | primary key, non-null, unique |
| task_name | string | non-null |
| user_id | number | non-null |
| status_id | number | non-null |
| label_id | number | non-null |
| done_at | time | non-null |
-
+
- task represents tasks and its status. +
Status
+| column | type | remarks |
|---|---|---|
| status_id | number | primary key, non-null, unique |
| status_name | string | non-null, unique |
-
+
- status represents task's status. like "Backlog", "ToDo", "Doing" and "Done" will be inserted here. +
Consume
+| column | type | remarks |
|---|---|---|
| consume_id | number | primary key, non-null, unique |
| task_id | number | non-null |
| started_at | time | non-null |
| finished_at | time | non-null |
| consumed | time | non-null |
-
+
- consume represents how many times are consumed for specified task. +
Label
+| column | type | remarks |
|---|---|---|
| label_id | number | primary key, non-null, unique |
| label_name | string | non-null |
-
+
- label represents task's label. this is used to task classification. +
ER diagram
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/communication/front2daemon.html b/docs/communication/front2daemon.html
deleted file mode 100644
index 3519018a..00000000
--- a/docs/communication/front2daemon.html
+++ /dev/null
@@ -1,388 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Communication between daemon to datastore
-Overview
--
-
- Use GRPC for communication between daemon and datastore
-
-
- Daemon send array of command, and datastore will apply them -
- Daemon retrieves updates from datastore periodically for syncing -
-
GRPC APIs
--
-
- Use Hashira service. See daemon overview. -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/daemon/entity.html b/docs/daemon/entity.html
deleted file mode 100644
index 6fa278c0..00000000
--- a/docs/daemon/entity.html
+++ /dev/null
@@ -1,356 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Communication between front to daemon
-Overview
--
-
- hashira uses GRPC for communication between front and daemon -
PC
-CLI and Daemon
--
-
- CLI to Daemon
-
-
- Add a new task to Backlog -
- Change task's status -
- Show task list -
- - Daemon to CLI
-
-
- None -
-
GUI and Daemon
--
-
- Assume to use Electron -
- GUI to daemon
-
-
- Add a new task to Backlog, ToDo, Doing, Done -
- Change task's status -
- Show task list on each status -
- Show consume of each task -
- Daemon to GUI
--
-
- notify any update of tasks -
-TODO: Show GUI picture
-
-
Android
-application and daemon
--
-
- GUI to Daemon
-
-
- Add a new task to Backlog, ToDo, Doing, Done -
- Change task's status -
- Show task list on each status -
- Show consume of each task -
- Daemon to GUI
--
-
- Notify any update of tasks -
-TODO: Show GUI picture
-
-
Widget and Daemon
--
-
- Widget to Daemon
-
-
- Add a new task to Backlog -
- Change task's status to Done -
- Show task list -
- Daemon to widget
--
-
- Notify any update of tasks -
-TODO: Show GUI picture
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/daemon/overview.html b/docs/daemon/overview.html
deleted file mode 100644
index 981f129e..00000000
--- a/docs/daemon/overview.html
+++ /dev/null
@@ -1,421 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data entities for local document store
--
-
Two data entities are declared for local document store.
--
-
- Tasks -
- Priorities -
-Refer proto file for latest data entity declaration.
-
-
Tasks
--
-
- Tasks represents each ToDo items. -
message Task {
- string id = 1;
- string name = 2;
- Place place = 3;
- bool isDeleted = 4;
-}
-Priorities
--
-
- Priorities represents priority of each task.
-
-
- Priorities are represented as its place and array of task ID. -
- The ID placed on lower index means higher priority. -
-
message Priority {
- Place place = 1;
- repeated string ids = 2;
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/gitbook/fonts/fontawesome/FontAwesome.otf b/docs/gitbook/fonts/fontawesome/FontAwesome.otf
deleted file mode 100644
index d4de13e8..00000000
Binary files a/docs/gitbook/fonts/fontawesome/FontAwesome.otf and /dev/null differ
diff --git a/docs/gitbook/fonts/fontawesome/fontawesome-webfont.eot b/docs/gitbook/fonts/fontawesome/fontawesome-webfont.eot
deleted file mode 100644
index c7b00d2b..00000000
Binary files a/docs/gitbook/fonts/fontawesome/fontawesome-webfont.eot and /dev/null differ
diff --git a/docs/gitbook/fonts/fontawesome/fontawesome-webfont.svg b/docs/gitbook/fonts/fontawesome/fontawesome-webfont.svg
deleted file mode 100644
index 8b66187f..00000000
--- a/docs/gitbook/fonts/fontawesome/fontawesome-webfont.svg
+++ /dev/null
@@ -1,685 +0,0 @@
-
-
-
\ No newline at end of file
diff --git a/docs/gitbook/fonts/fontawesome/fontawesome-webfont.woff b/docs/gitbook/fonts/fontawesome/fontawesome-webfont.woff
deleted file mode 100644
index 6e7483cf..00000000
Binary files a/docs/gitbook/fonts/fontawesome/fontawesome-webfont.woff and /dev/null differ
diff --git a/docs/gitbook/fonts/fontawesome/fontawesome-webfont.woff2 b/docs/gitbook/fonts/fontawesome/fontawesome-webfont.woff2
deleted file mode 100644
index 7eb74fd1..00000000
Binary files a/docs/gitbook/fonts/fontawesome/fontawesome-webfont.woff2 and /dev/null differ
diff --git a/docs/gitbook/gitbook-plugin-fontsettings/fontsettings.js b/docs/gitbook/gitbook-plugin-fontsettings/fontsettings.js
deleted file mode 100644
index ff7be714..00000000
--- a/docs/gitbook/gitbook-plugin-fontsettings/fontsettings.js
+++ /dev/null
@@ -1,240 +0,0 @@
-require(['gitbook', 'jquery'], function(gitbook, $) {
- // Configuration
- var MAX_SIZE = 4,
- MIN_SIZE = 0,
- BUTTON_ID;
-
- // Current fontsettings state
- var fontState;
-
- // Default themes
- var THEMES = [
- {
- config: 'white',
- text: 'White',
- id: 0
- },
- {
- config: 'sepia',
- text: 'Sepia',
- id: 1
- },
- {
- config: 'night',
- text: 'Night',
- id: 2
- }
- ];
-
- // Default font families
- var FAMILIES = [
- {
- config: 'serif',
- text: 'Serif',
- id: 0
- },
- {
- config: 'sans',
- text: 'Sans',
- id: 1
- }
- ];
-
- // Return configured themes
- function getThemes() {
- return THEMES;
- }
-
- // Modify configured themes
- function setThemes(themes) {
- THEMES = themes;
- updateButtons();
- }
-
- // Return configured font families
- function getFamilies() {
- return FAMILIES;
- }
-
- // Modify configured font families
- function setFamilies(families) {
- FAMILIES = families;
- updateButtons();
- }
-
- // Save current font settings
- function saveFontSettings() {
- gitbook.storage.set('fontState', fontState);
- update();
- }
-
- // Increase font size
- function enlargeFontSize(e) {
- e.preventDefault();
- if (fontState.size >= MAX_SIZE) return;
-
- fontState.size++;
- saveFontSettings();
- }
-
- // Decrease font size
- function reduceFontSize(e) {
- e.preventDefault();
- if (fontState.size <= MIN_SIZE) return;
-
- fontState.size--;
- saveFontSettings();
- }
-
- // Change font family
- function changeFontFamily(configName, e) {
- if (e && e instanceof Event) {
- e.preventDefault();
- }
-
- var familyId = getFontFamilyId(configName);
- fontState.family = familyId;
- saveFontSettings();
- }
-
- // Change type of color theme
- function changeColorTheme(configName, e) {
- if (e && e instanceof Event) {
- e.preventDefault();
- }
-
- var $book = gitbook.state.$book;
-
- // Remove currently applied color theme
- if (fontState.theme !== 0)
- $book.removeClass('color-theme-'+fontState.theme);
-
- // Set new color theme
- var themeId = getThemeId(configName);
- fontState.theme = themeId;
- if (fontState.theme !== 0)
- $book.addClass('color-theme-'+fontState.theme);
-
- saveFontSettings();
- }
-
- // Return the correct id for a font-family config key
- // Default to first font-family
- function getFontFamilyId(configName) {
- // Search for plugin configured font family
- var configFamily = $.grep(FAMILIES, function(family) {
- return family.config == configName;
- })[0];
- // Fallback to default font family
- return (!!configFamily)? configFamily.id : 0;
- }
-
- // Return the correct id for a theme config key
- // Default to first theme
- function getThemeId(configName) {
- // Search for plugin configured theme
- var configTheme = $.grep(THEMES, function(theme) {
- return theme.config == configName;
- })[0];
- // Fallback to default theme
- return (!!configTheme)? configTheme.id : 0;
- }
-
- function update() {
- var $book = gitbook.state.$book;
-
- $('.font-settings .font-family-list li').removeClass('active');
- $('.font-settings .font-family-list li:nth-child('+(fontState.family+1)+')').addClass('active');
-
- $book[0].className = $book[0].className.replace(/\bfont-\S+/g, '');
- $book.addClass('font-size-'+fontState.size);
- $book.addClass('font-family-'+fontState.family);
-
- if(fontState.theme !== 0) {
- $book[0].className = $book[0].className.replace(/\bcolor-theme-\S+/g, '');
- $book.addClass('color-theme-'+fontState.theme);
- }
- }
-
- function init(config) {
- // Search for plugin configured font family
- var configFamily = getFontFamilyId(config.family),
- configTheme = getThemeId(config.theme);
-
- // Instantiate font state object
- fontState = gitbook.storage.get('fontState', {
- size: config.size || 2,
- family: configFamily,
- theme: configTheme
- });
-
- update();
- }
-
- function updateButtons() {
- // Remove existing fontsettings buttons
- if (!!BUTTON_ID) {
- gitbook.toolbar.removeButton(BUTTON_ID);
- }
-
- // Create buttons in toolbar
- BUTTON_ID = gitbook.toolbar.createButton({
- icon: 'fa fa-font',
- label: 'Font Settings',
- className: 'font-settings',
- dropdown: [
- [
- {
- text: 'A',
- className: 'font-reduce',
- onClick: reduceFontSize
- },
- {
- text: 'A',
- className: 'font-enlarge',
- onClick: enlargeFontSize
- }
- ],
- $.map(FAMILIES, function(family) {
- family.onClick = function(e) {
- return changeFontFamily(family.config, e);
- };
-
- return family;
- }),
- $.map(THEMES, function(theme) {
- theme.onClick = function(e) {
- return changeColorTheme(theme.config, e);
- };
-
- return theme;
- })
- ]
- });
- }
-
- // Init configuration at start
- gitbook.events.bind('start', function(e, config) {
- var opts = config.fontsettings;
-
- // Generate buttons at start
- updateButtons();
-
- // Init current settings
- init(opts);
- });
-
- // Expose API
- gitbook.fontsettings = {
- enlargeFontSize: enlargeFontSize,
- reduceFontSize: reduceFontSize,
- setTheme: changeColorTheme,
- setFamily: changeFontFamily,
- getThemes: getThemes,
- setThemes: setThemes,
- getFamilies: getFamilies,
- setFamilies: setFamilies
- };
-});
-
-
diff --git a/docs/gitbook/gitbook-plugin-fontsettings/website.css b/docs/gitbook/gitbook-plugin-fontsettings/website.css
deleted file mode 100644
index 26591fe8..00000000
--- a/docs/gitbook/gitbook-plugin-fontsettings/website.css
+++ /dev/null
@@ -1,291 +0,0 @@
-/*
- * Theme 1
- */
-.color-theme-1 .dropdown-menu {
- background-color: #111111;
- border-color: #7e888b;
-}
-.color-theme-1 .dropdown-menu .dropdown-caret .caret-inner {
- border-bottom: 9px solid #111111;
-}
-.color-theme-1 .dropdown-menu .buttons {
- border-color: #7e888b;
-}
-.color-theme-1 .dropdown-menu .button {
- color: #afa790;
-}
-.color-theme-1 .dropdown-menu .button:hover {
- color: #73553c;
-}
-/*
- * Theme 2
- */
-.color-theme-2 .dropdown-menu {
- background-color: #2d3143;
- border-color: #272a3a;
-}
-.color-theme-2 .dropdown-menu .dropdown-caret .caret-inner {
- border-bottom: 9px solid #2d3143;
-}
-.color-theme-2 .dropdown-menu .buttons {
- border-color: #272a3a;
-}
-.color-theme-2 .dropdown-menu .button {
- color: #62677f;
-}
-.color-theme-2 .dropdown-menu .button:hover {
- color: #f4f4f5;
-}
-.book .book-header .font-settings .font-enlarge {
- line-height: 30px;
- font-size: 1.4em;
-}
-.book .book-header .font-settings .font-reduce {
- line-height: 30px;
- font-size: 1em;
-}
-.book.color-theme-1 .book-body {
- color: #704214;
- background: #f3eacb;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section {
- background: #f3eacb;
-}
-.book.color-theme-2 .book-body {
- color: #bdcadb;
- background: #1c1f2b;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section {
- background: #1c1f2b;
-}
-.book.font-size-0 .book-body .page-inner section {
- font-size: 1.2rem;
-}
-.book.font-size-1 .book-body .page-inner section {
- font-size: 1.4rem;
-}
-.book.font-size-2 .book-body .page-inner section {
- font-size: 1.6rem;
-}
-.book.font-size-3 .book-body .page-inner section {
- font-size: 2.2rem;
-}
-.book.font-size-4 .book-body .page-inner section {
- font-size: 4rem;
-}
-.book.font-family-0 {
- font-family: Georgia, serif;
-}
-.book.font-family-1 {
- font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal {
- color: #704214;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal a {
- color: inherit;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h1,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h2,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h3,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h4,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h5,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h6 {
- color: inherit;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h1,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h2 {
- border-color: inherit;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal h6 {
- color: inherit;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal hr {
- background-color: inherit;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal blockquote {
- border-color: inherit;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal pre,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal code {
- background: #fdf6e3;
- color: #657b83;
- border-color: #f8df9c;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal .highlight {
- background-color: inherit;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal table th,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal table td {
- border-color: #f5d06c;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal table tr {
- color: inherit;
- background-color: #fdf6e3;
- border-color: #444444;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal table tr:nth-child(2n) {
- background-color: #fbeecb;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal {
- color: #bdcadb;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal a {
- color: #3eb1d0;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h1,
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h2,
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h3,
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h4,
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h5,
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h6 {
- color: #fffffa;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h1,
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h2 {
- border-color: #373b4e;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal h6 {
- color: #373b4e;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal hr {
- background-color: #373b4e;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal blockquote {
- border-color: #373b4e;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal pre,
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal code {
- color: #9dbed8;
- background: #2d3143;
- border-color: #2d3143;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal .highlight {
- background-color: #282a39;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal table th,
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal table td {
- border-color: #3b3f54;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal table tr {
- color: #b6c2d2;
- background-color: #2d3143;
- border-color: #3b3f54;
-}
-.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal table tr:nth-child(2n) {
- background-color: #35394b;
-}
-.book.color-theme-1 .book-header {
- color: #afa790;
- background: transparent;
-}
-.book.color-theme-1 .book-header .btn {
- color: #afa790;
-}
-.book.color-theme-1 .book-header .btn:hover {
- color: #73553c;
- background: none;
-}
-.book.color-theme-1 .book-header h1 {
- color: #704214;
-}
-.book.color-theme-2 .book-header {
- color: #7e888b;
- background: transparent;
-}
-.book.color-theme-2 .book-header .btn {
- color: #3b3f54;
-}
-.book.color-theme-2 .book-header .btn:hover {
- color: #fffff5;
- background: none;
-}
-.book.color-theme-2 .book-header h1 {
- color: #bdcadb;
-}
-.book.color-theme-1 .book-body .navigation {
- color: #afa790;
-}
-.book.color-theme-1 .book-body .navigation:hover {
- color: #73553c;
-}
-.book.color-theme-2 .book-body .navigation {
- color: #383f52;
-}
-.book.color-theme-2 .book-body .navigation:hover {
- color: #fffff5;
-}
-/*
- * Theme 1
- */
-.book.color-theme-1 .book-summary {
- color: #afa790;
- background: #111111;
- border-right: 1px solid rgba(0, 0, 0, 0.07);
-}
-.book.color-theme-1 .book-summary .book-search {
- background: transparent;
-}
-.book.color-theme-1 .book-summary .book-search input,
-.book.color-theme-1 .book-summary .book-search input:focus {
- border: 1px solid transparent;
-}
-.book.color-theme-1 .book-summary ul.summary li.divider {
- background: #7e888b;
- box-shadow: none;
-}
-.book.color-theme-1 .book-summary ul.summary li i.fa-check {
- color: #33cc33;
-}
-.book.color-theme-1 .book-summary ul.summary li.done > a {
- color: #877f6a;
-}
-.book.color-theme-1 .book-summary ul.summary li a,
-.book.color-theme-1 .book-summary ul.summary li span {
- color: #877f6a;
- background: transparent;
- font-weight: normal;
-}
-.book.color-theme-1 .book-summary ul.summary li.active > a,
-.book.color-theme-1 .book-summary ul.summary li a:hover {
- color: #704214;
- background: transparent;
- font-weight: normal;
-}
-/*
- * Theme 2
- */
-.book.color-theme-2 .book-summary {
- color: #bcc1d2;
- background: #2d3143;
- border-right: none;
-}
-.book.color-theme-2 .book-summary .book-search {
- background: transparent;
-}
-.book.color-theme-2 .book-summary .book-search input,
-.book.color-theme-2 .book-summary .book-search input:focus {
- border: 1px solid transparent;
-}
-.book.color-theme-2 .book-summary ul.summary li.divider {
- background: #272a3a;
- box-shadow: none;
-}
-.book.color-theme-2 .book-summary ul.summary li i.fa-check {
- color: #33cc33;
-}
-.book.color-theme-2 .book-summary ul.summary li.done > a {
- color: #62687f;
-}
-.book.color-theme-2 .book-summary ul.summary li a,
-.book.color-theme-2 .book-summary ul.summary li span {
- color: #c1c6d7;
- background: transparent;
- font-weight: 600;
-}
-.book.color-theme-2 .book-summary ul.summary li.active > a,
-.book.color-theme-2 .book-summary ul.summary li a:hover {
- color: #f4f4f5;
- background: #252737;
- font-weight: 600;
-}
diff --git a/docs/gitbook/gitbook-plugin-highlight/ebook.css b/docs/gitbook/gitbook-plugin-highlight/ebook.css
deleted file mode 100644
index cecaaab5..00000000
--- a/docs/gitbook/gitbook-plugin-highlight/ebook.css
+++ /dev/null
@@ -1,135 +0,0 @@
-pre,
-code {
- /* http://jmblog.github.io/color-themes-for-highlightjs */
- /* Tomorrow Comment */
- /* Tomorrow Red */
- /* Tomorrow Orange */
- /* Tomorrow Yellow */
- /* Tomorrow Green */
- /* Tomorrow Aqua */
- /* Tomorrow Blue */
- /* Tomorrow Purple */
-}
-pre .hljs-comment,
-code .hljs-comment,
-pre .hljs-title,
-code .hljs-title {
- color: #8e908c;
-}
-pre .hljs-variable,
-code .hljs-variable,
-pre .hljs-attribute,
-code .hljs-attribute,
-pre .hljs-tag,
-code .hljs-tag,
-pre .hljs-regexp,
-code .hljs-regexp,
-pre .hljs-deletion,
-code .hljs-deletion,
-pre .ruby .hljs-constant,
-code .ruby .hljs-constant,
-pre .xml .hljs-tag .hljs-title,
-code .xml .hljs-tag .hljs-title,
-pre .xml .hljs-pi,
-code .xml .hljs-pi,
-pre .xml .hljs-doctype,
-code .xml .hljs-doctype,
-pre .html .hljs-doctype,
-code .html .hljs-doctype,
-pre .css .hljs-id,
-code .css .hljs-id,
-pre .css .hljs-class,
-code .css .hljs-class,
-pre .css .hljs-pseudo,
-code .css .hljs-pseudo {
- color: #c82829;
-}
-pre .hljs-number,
-code .hljs-number,
-pre .hljs-preprocessor,
-code .hljs-preprocessor,
-pre .hljs-pragma,
-code .hljs-pragma,
-pre .hljs-built_in,
-code .hljs-built_in,
-pre .hljs-literal,
-code .hljs-literal,
-pre .hljs-params,
-code .hljs-params,
-pre .hljs-constant,
-code .hljs-constant {
- color: #f5871f;
-}
-pre .ruby .hljs-class .hljs-title,
-code .ruby .hljs-class .hljs-title,
-pre .css .hljs-rules .hljs-attribute,
-code .css .hljs-rules .hljs-attribute {
- color: #eab700;
-}
-pre .hljs-string,
-code .hljs-string,
-pre .hljs-value,
-code .hljs-value,
-pre .hljs-inheritance,
-code .hljs-inheritance,
-pre .hljs-header,
-code .hljs-header,
-pre .hljs-addition,
-code .hljs-addition,
-pre .ruby .hljs-symbol,
-code .ruby .hljs-symbol,
-pre .xml .hljs-cdata,
-code .xml .hljs-cdata {
- color: #718c00;
-}
-pre .css .hljs-hexcolor,
-code .css .hljs-hexcolor {
- color: #3e999f;
-}
-pre .hljs-function,
-code .hljs-function,
-pre .python .hljs-decorator,
-code .python .hljs-decorator,
-pre .python .hljs-title,
-code .python .hljs-title,
-pre .ruby .hljs-function .hljs-title,
-code .ruby .hljs-function .hljs-title,
-pre .ruby .hljs-title .hljs-keyword,
-code .ruby .hljs-title .hljs-keyword,
-pre .perl .hljs-sub,
-code .perl .hljs-sub,
-pre .javascript .hljs-title,
-code .javascript .hljs-title,
-pre .coffeescript .hljs-title,
-code .coffeescript .hljs-title {
- color: #4271ae;
-}
-pre .hljs-keyword,
-code .hljs-keyword,
-pre .javascript .hljs-function,
-code .javascript .hljs-function {
- color: #8959a8;
-}
-pre .hljs,
-code .hljs {
- display: block;
- background: white;
- color: #4d4d4c;
- padding: 0.5em;
-}
-pre .coffeescript .javascript,
-code .coffeescript .javascript,
-pre .javascript .xml,
-code .javascript .xml,
-pre .tex .hljs-formula,
-code .tex .hljs-formula,
-pre .xml .javascript,
-code .xml .javascript,
-pre .xml .vbscript,
-code .xml .vbscript,
-pre .xml .css,
-code .xml .css,
-pre .xml .hljs-cdata,
-code .xml .hljs-cdata {
- opacity: 0.5;
-}
diff --git a/docs/gitbook/gitbook-plugin-highlight/website.css b/docs/gitbook/gitbook-plugin-highlight/website.css
deleted file mode 100644
index 6674448f..00000000
--- a/docs/gitbook/gitbook-plugin-highlight/website.css
+++ /dev/null
@@ -1,434 +0,0 @@
-.book .book-body .page-wrapper .page-inner section.normal pre,
-.book .book-body .page-wrapper .page-inner section.normal code {
- /* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
- /* Tomorrow Comment */
- /* Tomorrow Red */
- /* Tomorrow Orange */
- /* Tomorrow Yellow */
- /* Tomorrow Green */
- /* Tomorrow Aqua */
- /* Tomorrow Blue */
- /* Tomorrow Purple */
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-comment,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-comment,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-title {
- color: #8e908c;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-variable,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-variable,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-attribute,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-attribute,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-tag,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-tag,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-regexp,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-regexp,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-deletion,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-deletion,
-.book .book-body .page-wrapper .page-inner section.normal pre .ruby .hljs-constant,
-.book .book-body .page-wrapper .page-inner section.normal code .ruby .hljs-constant,
-.book .book-body .page-wrapper .page-inner section.normal pre .xml .hljs-tag .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal code .xml .hljs-tag .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal pre .xml .hljs-pi,
-.book .book-body .page-wrapper .page-inner section.normal code .xml .hljs-pi,
-.book .book-body .page-wrapper .page-inner section.normal pre .xml .hljs-doctype,
-.book .book-body .page-wrapper .page-inner section.normal code .xml .hljs-doctype,
-.book .book-body .page-wrapper .page-inner section.normal pre .html .hljs-doctype,
-.book .book-body .page-wrapper .page-inner section.normal code .html .hljs-doctype,
-.book .book-body .page-wrapper .page-inner section.normal pre .css .hljs-id,
-.book .book-body .page-wrapper .page-inner section.normal code .css .hljs-id,
-.book .book-body .page-wrapper .page-inner section.normal pre .css .hljs-class,
-.book .book-body .page-wrapper .page-inner section.normal code .css .hljs-class,
-.book .book-body .page-wrapper .page-inner section.normal pre .css .hljs-pseudo,
-.book .book-body .page-wrapper .page-inner section.normal code .css .hljs-pseudo {
- color: #c82829;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-number,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-number,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-preprocessor,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-preprocessor,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-pragma,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-pragma,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-built_in,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-built_in,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-literal,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-literal,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-params,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-params,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-constant,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-constant {
- color: #f5871f;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .ruby .hljs-class .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal code .ruby .hljs-class .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal pre .css .hljs-rules .hljs-attribute,
-.book .book-body .page-wrapper .page-inner section.normal code .css .hljs-rules .hljs-attribute {
- color: #eab700;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-string,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-string,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-value,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-value,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-inheritance,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-inheritance,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-header,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-header,
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-addition,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-addition,
-.book .book-body .page-wrapper .page-inner section.normal pre .ruby .hljs-symbol,
-.book .book-body .page-wrapper .page-inner section.normal code .ruby .hljs-symbol,
-.book .book-body .page-wrapper .page-inner section.normal pre .xml .hljs-cdata,
-.book .book-body .page-wrapper .page-inner section.normal code .xml .hljs-cdata {
- color: #718c00;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .css .hljs-hexcolor,
-.book .book-body .page-wrapper .page-inner section.normal code .css .hljs-hexcolor {
- color: #3e999f;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-function,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-function,
-.book .book-body .page-wrapper .page-inner section.normal pre .python .hljs-decorator,
-.book .book-body .page-wrapper .page-inner section.normal code .python .hljs-decorator,
-.book .book-body .page-wrapper .page-inner section.normal pre .python .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal code .python .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal pre .ruby .hljs-function .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal code .ruby .hljs-function .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal pre .ruby .hljs-title .hljs-keyword,
-.book .book-body .page-wrapper .page-inner section.normal code .ruby .hljs-title .hljs-keyword,
-.book .book-body .page-wrapper .page-inner section.normal pre .perl .hljs-sub,
-.book .book-body .page-wrapper .page-inner section.normal code .perl .hljs-sub,
-.book .book-body .page-wrapper .page-inner section.normal pre .javascript .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal code .javascript .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal pre .coffeescript .hljs-title,
-.book .book-body .page-wrapper .page-inner section.normal code .coffeescript .hljs-title {
- color: #4271ae;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs-keyword,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs-keyword,
-.book .book-body .page-wrapper .page-inner section.normal pre .javascript .hljs-function,
-.book .book-body .page-wrapper .page-inner section.normal code .javascript .hljs-function {
- color: #8959a8;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .hljs,
-.book .book-body .page-wrapper .page-inner section.normal code .hljs {
- display: block;
- background: white;
- color: #4d4d4c;
- padding: 0.5em;
-}
-.book .book-body .page-wrapper .page-inner section.normal pre .coffeescript .javascript,
-.book .book-body .page-wrapper .page-inner section.normal code .coffeescript .javascript,
-.book .book-body .page-wrapper .page-inner section.normal pre .javascript .xml,
-.book .book-body .page-wrapper .page-inner section.normal code .javascript .xml,
-.book .book-body .page-wrapper .page-inner section.normal pre .tex .hljs-formula,
-.book .book-body .page-wrapper .page-inner section.normal code .tex .hljs-formula,
-.book .book-body .page-wrapper .page-inner section.normal pre .xml .javascript,
-.book .book-body .page-wrapper .page-inner section.normal code .xml .javascript,
-.book .book-body .page-wrapper .page-inner section.normal pre .xml .vbscript,
-.book .book-body .page-wrapper .page-inner section.normal code .xml .vbscript,
-.book .book-body .page-wrapper .page-inner section.normal pre .xml .css,
-.book .book-body .page-wrapper .page-inner section.normal code .xml .css,
-.book .book-body .page-wrapper .page-inner section.normal pre .xml .hljs-cdata,
-.book .book-body .page-wrapper .page-inner section.normal code .xml .hljs-cdata {
- opacity: 0.5;
-}
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal pre,
-.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal code {
- /*
-
-Orginal Style from ethanschoonover.com/solarized (c) Jeremy Hull
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Overview of Daemon's functionality
--
-
- Daemon has responsibility for
-
-
- Receive requests from front end. -
- Caches commands and reflect them to local document store for working without network. -
- Send chunk of commands to datastore for syncing. -
- Receive chunk of data to sync with datastore. -
-
Caches data entities on local document store
--
-
- Caches commands and reflect them to local document store for working without network.
-
-
- here is data entities for local document store -
-
Sync with datastore
--
-
- Daemon has a document store to cache commands from front end, and store data from datastore. -
- Periodically, daemon tries to perform syncing local data with datastore.
-
-
- Send local commands, that are "not synced yet", to datastore. -
- Retrieve chunk of data. They are JSON formatted and represent "1 week of data", for example. -
- Daemon stores 10 weeks of data in local document store. -
-
GRPC API
--
-
Hashira Service
--
-
- send(array of command)
-
-
- sends specified commands. -
- - retrieve(from, to (number of weeks)) array of task
-
-
- returns array of task with specified term. -
-
-- send(array of command)
command and related enumeration
-
-
what (enum)
-| enum | -remarks | -
|---|---|
| new | -create a new task | -
| update | -update state of a task | -
command (structure)
-| field | -type | -remarks | -
|---|---|---|
| what | -enum of what | -new, update, etc. | -
| payload | -string | -JSON formatted string how to treat what. | -
Command handling
--
-
- When daemon receives commands, cache them and return ok immediately. -
- If daemon is online, send cached commands to datastore. -
- When datastore receives commands and succeed to apply them, datastore sends notification to daemon. -
- At daemon receiving notification, retrieve chunk of data from datastore for syncing. -
- When daemon succeed to apply them, daemon sends notification to front end. -
- At front end receiving notification, retrieve chunk of data from daemon. -
When front end succeed to retrieve chunk of data, render them.
-
-If daemon is offline, postpone to send commands to datastore.
--
-
- Instead, daemon applies the cached commands to local document store, -and send notification to front end as same as written above. -
-
