Jakub Čábera
7 years ago
16 changed files with 91 additions and 104 deletions
@ -1,28 +1,29 @@
|
||||
## Adding a service |
||||
# Adding a service |
||||
|
||||
The available services are stored in the [ServicesList.js](../store/ServicesList.js). |
||||
|
||||
The available services are stored in the [ServiceList.js](app/store/ServicesList.js). |
||||
Structure of a service entry: |
||||
|
||||
|Name|Description|Required| |
||||
|---|---|---| |
||||
|id|Unique identifier for the service, e.g. "slack"|yes| |
||||
|logo|File name of the service logo located in "/resources/icons/", e.g. "slack.png"|yes| |
||||
|name|Visible name for the service, e.g. "Slack"|yes| |
||||
|description|A short description of the service, e.g. "Slack brings all your communication together..."|yes| |
||||
|url|URL of the service, e.g. "https://\_\_\_.slack.com/". "\_\_\_" may be used as a placeholder, that can be configured when adding a service.|yes| |
||||
|type|Defines the type of the service. Must be one of `email` or `messaging`.|yes| |
||||
|allow_popups|Set to `true` to allow popup windows for the service.|no| |
||||
|note|Additional info to display when adding the service.|no| |
||||
|manual_notifications|Set to `true` to let Rambox trigger notifications. Can be used for services that doesn't support browser notifications.|no| |
||||
|js_unread|JavaScript code for setting the unread count (see below).|no| |
||||
|dont_update_unread_from_title|Set to `true` to prevent updating the unread count from the window title (see below).|no| |
||||
| Name | Description | Required | |
||||
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------- | |
||||
| id | Unique identifier for the service, e.g. "**slack**" | yes | |
||||
| logo | File name of the service logo located in `/resources/icons/`, e.g. "**slack.png**" | yes | |
||||
| name | Visible name for the service, e.g. "**Slack**" | yes | |
||||
| description | A short description of the service, e.g. "**Slack brings all your communication together...**" | yes | |
||||
| url | URL of the service, e.g. "<https://\_\_\_.slack.com/>". "\_\_\_" may be used as a placeholder, that can be configured when adding a service. | yes | |
||||
| type | Defines the type of the service. Must be one of `email` or `messaging`. | yes | |
||||
| allow_popups | Set to `true` to allow popup windows for the service. | no | |
||||
| note | Additional info to display when adding the service. | no | |
||||
| manual_notifications | Set to `true` to let Rambox trigger notifications. Can be used for services that doesn't support browser notifications. | no | |
||||
| js_unread | JavaScript code for setting the unread count (see below). | no | |
||||
| dont_update_unread_from_title | Set to `true` to prevent updating the unread count from the window title (see below). | no | |
||||
|
||||
### Setting the unread count |
||||
## Setting the unread count |
||||
|
||||
While there is also a way to set the unread count by adding ` (COUNT)` to the window title, this describes the preferred way of doing it: |
||||
While there is also a way to set the unread count by adding `(COUNT)` to the window title, this describes the preferred way of doing it: |
||||
|
||||
First set `dont_update_unread_from_title` in the service config to `true`. |
||||
|
||||
Code provided by `js_unread` will be injected into the service website. |
||||
You can retrieve the unread count in this JavaScript code e.g. by parsing elements. |
||||
Set the unread count by calling `rambox.setUnreadCount(COUNT)` or clear it by calling `rambox.clearUnreadCount()`. |
||||
Set the unread count by calling `rambox.setUnreadCount(COUNT)` or clear it by calling `rambox.clearUnreadCount()`. |
||||
|
||||
@ -1,3 +1,3 @@
|
||||
# ext-aria/resources |
||||
|
||||
This folder contains static resources (typically an `"images"` folder as well). |
||||
This folder contains static resources (typically an `images` folder as well). |
||||
|
||||
@ -1,3 +1,3 @@
|
||||
# ext-aria/resources |
||||
|
||||
This folder contains static resources (typically an `"images"` folder as well). |
||||
This folder contains static resources (typically an `images` folder as well). |
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# ext-aria/sass/etc |
||||
|
||||
This folder contains miscellaneous SASS files. Unlike `"ext-aria/sass/etc"`, these files |
||||
need to be used explicitly. |
||||
This folder contains miscellaneous SASS files. |
||||
Unlike `ext-aria/sass/etc`, these files need to be used explicitly. |
||||
|
||||
@ -1,38 +1,45 @@
|
||||
# rambox-default-theme/examples |
||||
|
||||
This folder contains example applications demonstrating this package. Each of |
||||
these applications will be built as part of the package build: |
||||
This folder contains example applications demonstrating this package. |
||||
Each of these applications will be built as part of the package build: |
||||
|
||||
cd /path/to/package |
||||
sencha package build |
||||
```bash |
||||
cd /path/to/package |
||||
sencha package build |
||||
``` |
||||
|
||||
As applications, they can also be built individually: |
||||
|
||||
cd /path/to/package/examples/example-app |
||||
sencha app build |
||||
```bash |
||||
cd /path/to/package/examples/example-app |
||||
sencha app build |
||||
``` |
||||
|
||||
Or you can build all examples as a group: |
||||
|
||||
cd /path/to/package |
||||
sencha ant examples |
||||
```bash |
||||
cd /path/to/package |
||||
sencha ant examples |
||||
``` |
||||
|
||||
The ideal location for the example builds to reside is the `"./build"` folder: |
||||
|
||||
/path/to/package/ |
||||
src/ |
||||
resources/ |
||||
```text |
||||
/path/to/package/ |
||||
src/ |
||||
resources/ |
||||
... |
||||
examples/ |
||||
example-app/ |
||||
other-example/ |
||||
... |
||||
build/ |
||||
resources/ |
||||
examples/ |
||||
example-app/ |
||||
other-example/ |
||||
... |
||||
build/ |
||||
resources/ |
||||
examples/ |
||||
example-app/ |
||||
other-example/ |
||||
``` |
||||
|
||||
This can be specified in the `".sencha/app/build.properties"` file for the |
||||
example applications: |
||||
This can be specified in the `".sencha/app/build.properties"` file for the example applications: |
||||
|
||||
build.dir=${package.build.dir}/examples/${app.name} |
||||
`build.dir=${package.build.dir}/examples/${app.name}` |
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# rambox-default-theme/sass/etc |
||||
|
||||
This folder contains miscellaneous SASS files. Unlike `"rambox-default-theme/sass/etc"`, these files |
||||
need to be used explicitly. |
||||
This folder contains miscellaneous SASS files. |
||||
Unlike `"rambox-default-theme/sass/etc"`, these files need to be used explicitly. |
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# rambox-default-theme/sass/src |
||||
|
||||
This folder contains SASS sources that mimic the component-class hierarchy. These files |
||||
are gathered in to a build of the CSS based on classes that are used by the build. |
||||
This folder contains SASS sources that mimic the component-class hierarchy. |
||||
These files are gathered in to a build of the CSS based on classes that are used by the build. |
||||
|
||||
@ -1,4 +1,3 @@
|
||||
# rambox-default-theme/src |
||||
|
||||
This folder contains source code that will automatically be added to the classpath when |
||||
the package is used. |
||||
This folder contains source code that will automatically be added to the classpath when the package is used. |
||||
|
||||
@ -1,4 +0,0 @@
|
||||
# Rambox/resources |
||||
|
||||
This folder contains resources (such as images) needed by the application. This file can |
||||
be removed if not needed. |
||||
Loading…
Reference in new issue