Published with http://benweet.github.io/stackedit/
This commit is contained in:
parent
c564b74c39
commit
88d224aa84
@ -9,8 +9,10 @@ Architecture
|
|||||||
|
|
||||||
![Architecture diagram][1]
|
![Architecture diagram][1]
|
||||||
|
|
||||||
|
> **NOTE:**
|
||||||
|
|
||||||
StackEdit uses [RequireJS][2] for asynchronous module definition ([AMD][3]).
|
> - StackEdit uses [RequireJS][2] for asynchronous module definition ([AMD][3]).
|
||||||
|
> - [jQuery][4], [Underscore.js][5] or any other 3rd party libraries can be called from anywhere as long as they have been declared as module dependencies.
|
||||||
|
|
||||||
|
|
||||||
----------
|
----------
|
||||||
@ -20,29 +22,29 @@ StackEdit uses [RequireJS][2] for asynchronous module definition ([AMD][3]).
|
|||||||
|
|
||||||
The `core` module is responsible for:
|
The `core` module is responsible for:
|
||||||
|
|
||||||
- creating the [UI Layout][4],
|
- creating the [UI Layout][6],
|
||||||
- creating the [PageDown][5] editor,
|
- creating the [PageDown][7] editor,
|
||||||
- loading/saving the settings,
|
- loading/saving the settings,
|
||||||
- running periodic tasks,
|
- running periodic tasks,
|
||||||
- detecting the user activity,
|
- detecting the user activity,
|
||||||
- checking the offline status.
|
- checking the offline status.
|
||||||
|
|
||||||
##### Attributes:
|
**Attributes:**
|
||||||
|
|
||||||
- `isOffline`: indicates the offline status of the application.
|
- `core.isOffline`: indicates the offline status of the application.
|
||||||
|
|
||||||
##### Methods:
|
**Methods:**
|
||||||
|
|
||||||
- `core.onReady(callback)`: sets a callback to be called when all modules have been loaded and the DOM is ready.
|
- `core.onReady(callback)`: sets a callback to be called when all modules have been loaded and the DOM is ready.
|
||||||
> **NOTE:** This is preferred over [jQuery's `.ready()`][6] because it ensures that all AMD modules are loaded by [RequireJS][2]).
|
> **NOTE:** This is preferred over [jQuery's `.ready()`][8] because it ensures that all AMD modules are loaded by [RequireJS][9]).
|
||||||
|
|
||||||
- `runPeriodically(callback)`: sets a callback to be called every second.
|
- `core.runPeriodically(callback)`: sets a callback to be called every second.
|
||||||
> **NOTE:** The callback will not run if the user is inactive or in StackEdit Viewer. User is considered inactive after 5 minutes of inactivity (mouse or keyboard).
|
> **NOTE:** The callback will not run if the user is inactive or in StackEdit Viewer. User is considered inactive after 5 minutes of inactivity (mouse or keyboard).
|
||||||
|
|
||||||
- `setOffline()`: can be called by any other modules when a network timeout occurs for instance.
|
- `core.setOffline()`: can be called by any other modules when a network timeout occurs for instance.
|
||||||
> **NOTE:** the offline status is also set by detecting the window `offline` event. `isOffline` is automatically set to `false` when the network is recovered.
|
> **NOTE:** the offline status is also set by detecting the window `offline` event. `core.isOffline` is automatically set to `false` when the network is recovered.
|
||||||
|
|
||||||
- `initEditor(fileDesc)`: creates or refreshes the [PageDown][7] editor with a given [`FileDescriptor`][8] object.
|
- `core.initEditor(fileDesc)`: creates or refreshes the [PageDown][10] editor with a given [`FileDescriptor`][11] object.
|
||||||
|
|
||||||
|
|
||||||
----------
|
----------
|
||||||
@ -62,19 +64,19 @@ The `FileDescriptor` class represents a local file. A `FileDescriptor` object ha
|
|||||||
- `fileIndex`: the unique string index of the file in the file system
|
- `fileIndex`: the unique string index of the file in the file system
|
||||||
- `title`: the title of the document
|
- `title`: the title of the document
|
||||||
- `content`: the content of the document
|
- `content`: the content of the document
|
||||||
- `syncLocations`: a map containing all the associated [`syncAttributes`][9] objects with their `syncIndex` as a key
|
- `syncLocations`: a map containing all the associated [`syncAttributes`][12] objects with their `syncIndex` as a key
|
||||||
- `publishLocations`: a map containing all the associated [`publishAttributes`][10] objects with their `publishIndex` as a key
|
- `publishLocations`: a map containing all the associated [`publishAttributes`][13] objects with their `publishIndex` as a key
|
||||||
|
|
||||||
And the following methods:
|
And the following methods:
|
||||||
|
|
||||||
- `addSyncLocation(syncAttributes)`: associates a [`syncAttributes`][11] object with the file
|
- `addSyncLocation(syncAttributes)`: associates a [`syncAttributes`][14] object with the file
|
||||||
- `removeSyncLocation(syncAttributes)`: unassociates a [`syncAttributes`][12] object with the file
|
- `removeSyncLocation(syncAttributes)`: unassociates a [`syncAttributes`][15] object with the file
|
||||||
- `addPublishLocation(publishAttributes)`: associates a [`publishAttributes`][13] object with the file
|
- `addPublishLocation(publishAttributes)`: associates a [`publishAttributes`][16] object with the file
|
||||||
- `removePublishLocation(publishAttributes)`: unassociates a [`publishAttributes`][14] object with the file
|
- `removePublishLocation(publishAttributes)`: unassociates a [`publishAttributes`][17] object with the file
|
||||||
|
|
||||||
#### fileSystem
|
#### fileSystem
|
||||||
|
|
||||||
The `fileSystem` module is a map containing all the [`FileDescriptor`][15] objects with their `fileIndex` as a key
|
The `fileSystem` module is a map containing all the [`FileDescriptor`][18] objects with their `fileIndex` as a key
|
||||||
|
|
||||||
|
|
||||||
----------
|
----------
|
||||||
@ -90,7 +92,7 @@ The `synchronizer` module is responsible for:
|
|||||||
|
|
||||||
#### synchronizer's providers
|
#### synchronizer's providers
|
||||||
|
|
||||||
A [`provider`][16] module can be associated with the `synchronizer` module if it implements the following functions:
|
A [`provider`][19] module can be associated with the `synchronizer` module if it implements the following functions:
|
||||||
|
|
||||||
- `importFiles()`: downloads one or multiple files and create local files associated with the sync locations
|
- `importFiles()`: downloads one or multiple files and create local files associated with the sync locations
|
||||||
- `exportFile()`: uploads a local file to a new sync location
|
- `exportFile()`: uploads a local file to a new sync location
|
||||||
@ -102,7 +104,7 @@ A [`provider`][16] module can be associated with the `synchronizer` module if it
|
|||||||
A `syncAttributes` object is an object that describes a sync location. Attributes differ from one provider to another except for the following:
|
A `syncAttributes` object is an object that describes a sync location. Attributes differ from one provider to another except for the following:
|
||||||
|
|
||||||
- `syncIndex`: the unique string index of the publish location
|
- `syncIndex`: the unique string index of the publish location
|
||||||
- `provider`: the [`provider`][17] module that handles the sync location
|
- `provider`: the [`provider`][20] module that handles the sync location
|
||||||
|
|
||||||
|
|
||||||
----------
|
----------
|
||||||
@ -117,9 +119,9 @@ The `publisher` module is responsible for:
|
|||||||
|
|
||||||
#### publisher's providers
|
#### publisher's providers
|
||||||
|
|
||||||
A [`provider`][18] module can be associated with the `publisher` module if it implements the following functions:
|
A [`provider`][21] module can be associated with the `publisher` module if it implements the following functions:
|
||||||
|
|
||||||
- `newPublishAttributes()`: returns a new [`publishAttributes`][19] object in order to create a new publish location
|
- `newPublishAttributes()`: returns a new [`publishAttributes`][22] object in order to create a new publish location
|
||||||
- `publish()`: performs publishing of one publish location
|
- `publish()`: performs publishing of one publish location
|
||||||
|
|
||||||
#### publishAttributes
|
#### publishAttributes
|
||||||
@ -127,7 +129,7 @@ A [`provider`][18] module can be associated with the `publisher` module if it im
|
|||||||
A `publishAttributes` object is an object that describes a publish location. Attributes differ from one provider to another except for the following:
|
A `publishAttributes` object is an object that describes a publish location. Attributes differ from one provider to another except for the following:
|
||||||
|
|
||||||
- `publishIndex`: the unique string index of the publish location
|
- `publishIndex`: the unique string index of the publish location
|
||||||
- `provider`: the [`provider`][20] module that handles the publish location
|
- `provider`: the [`provider`][23] module that handles the publish location
|
||||||
- `format`: the publishing format for the publish location. It can be:
|
- `format`: the publishing format for the publish location. It can be:
|
||||||
- `markdown` for Markdown format
|
- `markdown` for Markdown format
|
||||||
- `html` for HTML format
|
- `html` for HTML format
|
||||||
@ -150,20 +152,23 @@ A `publishAttributes` object is an object that describes a publish location. Att
|
|||||||
[1]: http://benweet.github.io/stackedit/doc/img/architecture.png "Architecture diagram"
|
[1]: http://benweet.github.io/stackedit/doc/img/architecture.png "Architecture diagram"
|
||||||
[2]: http://requirejs.org/ "RequireJS"
|
[2]: http://requirejs.org/ "RequireJS"
|
||||||
[3]: http://en.wikipedia.org/wiki/Asynchronous_module_definition "Asynchronous module definition"
|
[3]: http://en.wikipedia.org/wiki/Asynchronous_module_definition "Asynchronous module definition"
|
||||||
[4]: http://layout.jquery-dev.net/ "UI Layout"
|
[4]: http://jquery.com/
|
||||||
[5]: https://code.google.com/p/pagedown/ "PageDown"
|
[5]: http://underscorejs.org/
|
||||||
[6]: http://api.jquery.com/ready/
|
[6]: http://layout.jquery-dev.net/ "UI Layout"
|
||||||
[7]: https://code.google.com/p/pagedown/ "PageDown"
|
[7]: https://code.google.com/p/pagedown/ "PageDown"
|
||||||
[8]: #filedescriptor
|
[8]: http://api.jquery.com/ready/
|
||||||
[9]: #syncattributes
|
[9]: http://requirejs.org/ "RequireJS"
|
||||||
[10]: #publishattributes
|
[10]: https://code.google.com/p/pagedown/ "PageDown"
|
||||||
[11]: #syncattributes
|
[11]: #filedescriptor
|
||||||
[12]: #syncattributes
|
[12]: #syncattributes
|
||||||
[13]: #publishattributes
|
[13]: #publishattributes
|
||||||
[14]: #publishattributes
|
[14]: #syncattributes
|
||||||
[15]: #filedescriptor
|
[15]: #syncattributes
|
||||||
[16]: #provider
|
[16]: #publishattributes
|
||||||
[17]: #provider
|
[17]: #publishattributes
|
||||||
[18]: #provider
|
[18]: #filedescriptor
|
||||||
[19]: #publishattributes
|
[19]: #provider
|
||||||
[20]: #provider
|
[20]: #provider
|
||||||
|
[21]: #provider
|
||||||
|
[22]: #publishattributes
|
||||||
|
[23]: #provider
|
Loading…
Reference in New Issue
Block a user