mirror of
https://github.com/johannesjo/super-productivity.git
synced 2026-07-29 02:30:03 +00:00
add documentation for configuration
This commit is contained in:
Johannes Millan
parent
08a6b812e5
commit
05d471af8b
22 changed files with 186 additions and 9 deletions
|
|
@ -109,6 +109,7 @@ TODO configure more restrictive Content-Security-Policy
|
|||
<script src="scripts/download-backup/download-backup-d.js"></script>
|
||||
<script src="scripts/edit-on-click/edit-on-click-d.js"></script>
|
||||
<script src="scripts/external-link/external-link-d.js"></script>
|
||||
<script src="scripts/help-section/help-section-d.js"></script>
|
||||
<script src="scripts/hint/hint-d.js"></script>
|
||||
<script src="scripts/inline-markdown/inline-markdown-d.js"></script>
|
||||
<script src="scripts/input-duration/input-duration-d.js"></script>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<md-toolbar>
|
||||
<div class="md-toolbar-tools">
|
||||
<h2>
|
||||
<ng-md-icon icon="help"></ng-md-icon>
|
||||
<ng-md-icon icon="help_outline"></ng-md-icon>
|
||||
Help
|
||||
</h2>
|
||||
<span flex></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<h3 class="md-title">Settings page</h3>
|
||||
<p>Here you can configure a lot of stuff. Click the
|
||||
<ng-md-icon icon="help"></ng-md-icon>
|
||||
<ng-md-icon icon="help_outline"></ng-md-icon>
|
||||
-icons to learn more about a configuration section.
|
||||
</p>
|
||||
|
|
|
|||
25
app-src/scripts/help-section/_help-section-d.scss
Normal file
25
app-src/scripts/help-section/_help-section-d.scss
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
help-section {
|
||||
display: block;
|
||||
|
||||
.help-text {
|
||||
margin-bottom: 40px;
|
||||
border-bottom: 2px solid $c-accent;
|
||||
border-top: 2px solid $c-accent;
|
||||
}
|
||||
|
||||
.help-btn {
|
||||
position: absolute;
|
||||
top: -8px;
|
||||
right: -8px;
|
||||
}
|
||||
|
||||
.help-icon-wrapper {
|
||||
margin-top: 8px;
|
||||
margin-bottom: 8px;
|
||||
color: $c-accent;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
body.dark-theme & {
|
||||
}
|
||||
}
|
||||
17
app-src/scripts/help-section/help-section-d.html
Normal file
17
app-src/scripts/help-section/help-section-d.html
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
<md-button class="md-icon-button help-btn"
|
||||
aria-label="Show Help for section"
|
||||
ng-click="vm.isShowHelp =!vm.isShowHelp;">
|
||||
<ng-md-icon icon="help_outline"></ng-md-icon>
|
||||
</md-button>
|
||||
|
||||
<div class="help-text"
|
||||
ng-show="vm.isShowHelp">
|
||||
<div class="help-icon-wrapper">
|
||||
<ng-md-icon icon="help_outline"></ng-md-icon>
|
||||
</div>
|
||||
<ng-transclude></ng-transclude>
|
||||
<div class="help-icon-wrapper">
|
||||
<ng-md-icon icon="help_outline"></ng-md-icon>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
33
app-src/scripts/help-section/help-section-d.js
Normal file
33
app-src/scripts/help-section/help-section-d.js
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
/**
|
||||
* @ngdoc directive
|
||||
* @name superProductivity.directive:helpSection
|
||||
* @description
|
||||
* # helpSection
|
||||
*/
|
||||
|
||||
(function () {
|
||||
'use strict';
|
||||
|
||||
angular
|
||||
.module('superProductivity')
|
||||
.directive('helpSection', helpSection);
|
||||
|
||||
/* @ngInject */
|
||||
function helpSection() {
|
||||
return {
|
||||
templateUrl: 'scripts/help-section/help-section-d.html',
|
||||
bindToController: true,
|
||||
controller: HelpSectionCtrl,
|
||||
controllerAs: 'vm',
|
||||
transclude: true,
|
||||
restrict: 'E',
|
||||
scope: {}
|
||||
};
|
||||
}
|
||||
|
||||
/* @ngInject */
|
||||
function HelpSectionCtrl() {
|
||||
const vm = this;
|
||||
}
|
||||
|
||||
})();
|
||||
21
app-src/scripts/help-section/help-section-d.spec.js
Normal file
21
app-src/scripts/help-section/help-section-d.spec.js
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
'use strict';
|
||||
|
||||
describe('Directive: helpSection', function () {
|
||||
|
||||
// load the directive's module
|
||||
beforeEach(module('superProductivity'));
|
||||
beforeEach(module('templates'));
|
||||
|
||||
var element,
|
||||
scope;
|
||||
|
||||
beforeEach(inject(function ($rootScope) {
|
||||
scope = $rootScope.$new();
|
||||
}));
|
||||
|
||||
it('should do something', inject(function ($compile) {
|
||||
element = $compile('<help-section></help-section>')(scope);
|
||||
scope.$digest();
|
||||
expect(true).toBe(true);
|
||||
}));
|
||||
});
|
||||
|
|
@ -98,7 +98,7 @@
|
|||
<md-tooltip md-direction="bottom">
|
||||
Open help for current view
|
||||
</md-tooltip>
|
||||
<ng-md-icon icon="help"></ng-md-icon>
|
||||
<ng-md-icon icon="help_outline"></ng-md-icon>
|
||||
</md-button>
|
||||
</nav>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -20,6 +20,8 @@
|
|||
padding: 15px;
|
||||
margin-bottom: 10px;
|
||||
background: #ffffff;
|
||||
position: relative;
|
||||
|
||||
body.dark-theme & {
|
||||
background-color: $dark-theme-bg-lighter;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
backup-settings {
|
||||
|
||||
display: block;
|
||||
position: relative;
|
||||
}
|
||||
|
|
@ -2,6 +2,13 @@
|
|||
<ng-md-icon icon="swap_vert"></ng-md-icon>
|
||||
Make/Restore Backup
|
||||
</h2>
|
||||
|
||||
<help-section>
|
||||
<p>Here you can download all your data as <strong>JSON</strong> export for backups, but also to use it in a different context (e.g. you might want to export your projects in the browser and import them into the desktop version).</p>
|
||||
<p>The import expects valid json to be copied into the text area.
|
||||
<strong>NOTE: Once you hit the import button all your current settings and data will be overwritten!</strong></p>
|
||||
</help-section>
|
||||
|
||||
<a class="md-raised md-button md-ink-ripple"
|
||||
type="button"
|
||||
download-backup>
|
||||
|
|
@ -28,6 +35,10 @@
|
|||
md-auto-focus
|
||||
rows="3"></textarea>
|
||||
</md-input-container>
|
||||
|
||||
<div><strong>NOTE: Once you hit the import button all your current settings and data will be overwritten!</strong>
|
||||
</div>
|
||||
|
||||
<md-button type="submit"
|
||||
class="md-raised md-primary">Import settings
|
||||
</md-button>
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
jira-settings {
|
||||
|
||||
display: block;
|
||||
position: relative;
|
||||
}
|
||||
|
|
@ -3,6 +3,28 @@
|
|||
Enable Jira Integration
|
||||
</md-switch>
|
||||
|
||||
<help-section>
|
||||
<div class="md-caption">Basic configuration</div>
|
||||
<p>Basic configuration for Jira. You also need to specify a JQL query which is used for the suggestions to add tasks from jira. If you need help check out this link
|
||||
<a class="md-accent"
|
||||
href="https://confluence.atlassian.com/jirasoftwarecloud/advanced-searching-764478330.html"
|
||||
external-link="">https://confluence.atlassian.com/jirasoftwarecloud/advanced-searching-764478330.html</a>.</p>
|
||||
|
||||
<div class="md-caption">Worklog settings</div>
|
||||
<p>There are several options to determine when and how you want to submit a worklog. Enabling
|
||||
<em>'Open worklog dialog for adding a worklog to jira when task is done'</em> opens a dialog to add an worklog every time you mark a Jira Task as done. So keep in mind that worklogs will be added on top of everything tracked so far. So if you mark a task as done for a second time, you might not want to submit the complete worked time for the task again.
|
||||
</p>
|
||||
<p>
|
||||
<em>'Open worklog dialog when sub task is done and not for tasks with sub tasks themselves'</em> opens a worklog dialog every time when you mark a sub task of a jira issue as done. Because you already track your time via the sub tasks, no dialog is opened once you mark the Jira task itself as done,.
|
||||
</p>
|
||||
<p>
|
||||
<em>'Send updates to worklog automatically without dialog'</em> does what it says. Because marking a task as done several times leads to the whole worked time being tracked twice, this is not recommended.
|
||||
</p>
|
||||
|
||||
<div class="md-caption">Default transitions</div>
|
||||
<p>Here you can reconfigure your default transitions. Because Jira enables a wide configuration of transitions usually coming into action as different columns on your jira agile board we can't make assumptions about where and when to transition your tasks and you need to set it manually.</p>
|
||||
</help-section>
|
||||
|
||||
<div ng-show="vm.settings.isJiraEnabled">
|
||||
<h2 class="md-title">Jira-Integration</h2>
|
||||
<form>
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
keyboard-settings {
|
||||
|
||||
display: block;
|
||||
position: relative;
|
||||
}
|
||||
|
|
@ -3,6 +3,23 @@
|
|||
Keyboard Shortcuts
|
||||
</h2>
|
||||
|
||||
<help-section>
|
||||
<p>Here you can configure all keyboard shortcuts.</p>
|
||||
<p>Click on the text input and enter the desired keyboard combination. Hit enter to save and Escape to abort.</p>
|
||||
<p>There are three types of shortcuts:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Global shortcuts:</strong> When the app is running it will trigger the action from every other application.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Application level shortcuts:</strong> Will trigger from every screen of the application, but not if you're currently editing a text field.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Task level shortcuts:</strong> They will only trigger if you have selected a task via mouse or keyboard and usually trigger an action specifically related to that one task.
|
||||
</li>
|
||||
</ul>
|
||||
</help-section>
|
||||
|
||||
<section ng-if="vm.IS_ELECTRON">
|
||||
<h3 class="md-caption">Global Shortcuts (system wide)</h3>
|
||||
<md-input-container class="md-block">
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
misc-settings {
|
||||
|
||||
display: block;
|
||||
position: relative;
|
||||
}
|
||||
|
|
@ -2,6 +2,17 @@
|
|||
<ng-md-icon icon="settings"></ng-md-icon>
|
||||
Misc Settings
|
||||
</h2>
|
||||
|
||||
<help-section>
|
||||
<div class="md-caption">Use short syntax</div>
|
||||
<p>The short syntax can be enabled to quickly create tasks with an estimation already set. If you enter 'TaskTitleBla t:30m' a task with the name 'TaskTitleBla' will be created with the estimation set to 30 minutes.</p>
|
||||
|
||||
<div ng-if="vm.IS_ELECTRON">
|
||||
<div class="md-caption">Enable take a break reminder</div>
|
||||
<p>Allows you to configure a reoccurring reminder when you have worked for a specified amount of time without taking a break.</p>
|
||||
</div>
|
||||
</help-section>
|
||||
|
||||
<div>
|
||||
<md-switch ng-model="vm.settings.isShortSyntaxEnabled"
|
||||
aria-label="Use short syntax (e.g. 'TaskTitleBla e:30m')">
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
project-settings {
|
||||
|
||||
display: block;
|
||||
position: relative;
|
||||
}
|
||||
|
|
@ -3,6 +3,10 @@
|
|||
Project
|
||||
</h2>
|
||||
|
||||
<help-section>
|
||||
<p>Here you can add, edit, switch and delete different projects.</p>
|
||||
</help-section>
|
||||
|
||||
<div ng-if="vm.allProjects.length > 0">
|
||||
<md-input-container class="md-block">
|
||||
<label>Choose current project</label>
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
theme-settings {
|
||||
|
||||
display: block;
|
||||
position: relative;
|
||||
}
|
||||
|
|
@ -2,6 +2,11 @@
|
|||
<ng-md-icon icon="color_lens"></ng-md-icon>
|
||||
Select Theme
|
||||
</h2>
|
||||
|
||||
<help-section>
|
||||
<p>Select the theme you want to use. Themes are always saved on project level, which means that you can use different themes for different projects.</p>
|
||||
</help-section>
|
||||
|
||||
<md-select ng-model="vm.selectedTheme"
|
||||
placeholder="Select a theme">
|
||||
<md-option ng-repeat="themeName in vm.themes"
|
||||
|
|
|
|||
|
|
@ -95,6 +95,8 @@ IMPORTANT NOTE:
|
|||
|
||||
@import '../scripts/external-link/_external-link.scss';
|
||||
|
||||
@import '../scripts/help-section/_help-section-d.scss';
|
||||
|
||||
@import '../scripts/hint/_hint-d.scss';
|
||||
|
||||
@import '../scripts/inline-markdown/_inline-markdown-d.scss';
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue