Permalink
Browse files

Links updated with added missing `.md` extension

  • Loading branch information...
nazar-pc committed May 11, 2016
1 parent 5a0af28 commit d72acbaffd07aab374b0a35972f44cfcc089abe4
@@ -1,7 +1,7 @@
{
"package" : "Composer",
"category" : "modules",
"version" : "1.1.0+cs-1.0.1",
"version" : "1.1.0+cs-1.0.2",
"description" : "Composer integration into CleverStyle CMS, allows to specify composer dependencies in meta.json that will be installed automatically",
"author" : "Nazar Mokrynskyi",
"website" : "cleverstyle.org/cms",
@@ -16,5 +16,5 @@ <h3 style="text-align: center;">Composer integration into CleverStyle CMS, allow
}
</code>
</pre>
<p>NOTE: do not forget to specify other required fields of <i>meta.json</i> as specified <a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Module-architecture#metajson">in documentation</a>.</p>
<p>NOTE: do not forget to specify other required fields of <i>meta.json</i> as specified <a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Module-architecture.md#metajson">in documentation</a>.</p>
<p>Now if someone will install your component - it will need Composer package, and if it is installed - all composer packages will be installed and become available everywhere automatically.</p>
@@ -1,7 +1,7 @@
{
"package" : "Service_worker_cache",
"category" : "modules",
"version" : "0.2.1+build-4",
"version" : "0.2.2+build-5",
"description" : "Uses Service Worker to cache requests to static assets like CSS/JS/HTML/fonts/images to improve subsequent page loads, especially on bad internet connection",
"author" : "Nazar Mokrynskyi",
"website" : "cleverstyle.org/cms",
@@ -1,2 +1,2 @@
<h3 style="text-align: center;">Service Worker cache - uses Service Worker to cache requests to static assets like CSS/JS/HTML/fonts/images to improve subsequent page loads, especially on bad internet connection</h3>
<p>Only one caveat here, make sure Nginx should be configured properly (<a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Nginx-config-sample">Nginx config sample</a>).</p>
<p>Only one caveat here, make sure Nginx should be configured properly (<a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Nginx-config-sample.md">Nginx config sample</a>).</p>
@@ -1,7 +1,7 @@
{
"package" : "Shop",
"category" : "modules",
"version" : "0.159.6+build-258",
"version" : "0.159.7+build-259",
"description" : "Shop functionality",
"author" : "Nazar Mokrynskyi",
"website" : "cleverstyle.org/cms",
@@ -21,7 +21,7 @@ <h4 style="text-align: center;">For user</h4>
<h4 style="text-align: center;">For developer</h4>
<p>This section will describe how developer can extend Shop module to make it unique and implement necessary functionality that is not available out of the box.</p>
<h5 style="text-align: center;">Appearance</h5>
<p>All user-side elements are WebComponents, Polymer elements. This means that you can <a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Polymer-elements-extension">extend elements</a> using patched Polymer that comes with CleverStyle CMS easily:</p>
<p>All user-side elements are WebComponents, Polymer elements. This means that you can <a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Polymer-elements-extension.md">extend elements</a> using patched Polymer that comes with CleverStyle CMS easily:</p>
<pre>
<code class="language-markup">
&lt;polymer-element name="cs-shop-category" extends="cs-shop-category">
@@ -1,7 +1,7 @@
{
"package" : "System",
"category" : "modules",
"version" : "4.48.1+build-2124",
"version" : "4.48.2+build-2125",
"description" : "Base system module of CleverStyle CMS",
"author" : "Nazar Mokrynskyi",
"website" : "cleverstyle.org/cms",
@@ -1,7 +1,7 @@
{
"package" : "WebSockets",
"category" : "modules",
"version" : "0.53.4+build-85",
"version" : "0.53.5+build-86",
"description" : "WebSockets server based on Ratchet and React with client-side bindings as well",
"author" : "Nazar Mokrynskyi",
"website" : "cleverstyle.org/cms",
@@ -1,6 +1,6 @@
<h3 style="text-align: center;">WebSockets module, provides WebSockets integration into CleverStyle CMS both on server and on client</h3>
<p>WebSockets server is running in background and listen for incoming connections.</p>
<p>It is highly recommended to have working <code>exec()</code> function in PHP (otherwise fallback will be used, but not guaranteed to work) and Nginx should be configured properly (<a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Nginx-config-sample">Nginx config sample</a>).</p>
<p>It is highly recommended to have working <code>exec()</code> function in PHP (otherwise fallback will be used, but not guaranteed to work) and Nginx should be configured properly (<a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Nginx-config-sample.md">Nginx config sample</a>).</p>
There are two ways to run WebSockets server:
<dl>
<dt>CLI (recommended): <code>php components/modules/WebSockets/supervisor.php 'php components/modules/WebSockets/start_cli.php https://example.com'</code></dt>
@@ -1,4 +1,4 @@
### Contributing
It is great that you want to contribute to the project.

Please, make sure you're familiar with [development environment and contribution](/docs/Development-environment-and-contribution) on wiki before you send patches.
Please, make sure you're familiar with [development environment and contribution](/docs/Development-environment-and-contribution.md) on wiki before you send patches.
@@ -62,15 +62,15 @@ protected function load_config () {
if (PHP_SAPI == 'cli') {
echo <<<CONFIG_NOT_FOUND
Config file not found, is system installed properly?
How to install CleverStyle CMS: https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Installation
How to install CleverStyle CMS: https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Installation.md
CONFIG_NOT_FOUND;
} else {
echo /** @lang HTML */
<<<CONFIG_NOT_FOUND
<!doctype html>
<p>Config file not found, is system installed properly?</p>
<a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Installation">How to install CleverStyle CMS</a>
<a href="https://github.com/nazar-pc/CleverStyle-CMS/tree/master/docs/Installation.md">How to install CleverStyle CMS</a>
CONFIG_NOT_FOUND;
http_response_code(500);
}
@@ -1,3 +1,3 @@
This directory contains classes that extends functionality of system classes.
Content of this directory very likely is generated by third-party components, be very carefully when editing anything here.
Read more about this directory [here](/docs/System-classes-extension).
Read more about this directory [here](/docs/System-classes-extension.md).
@@ -371,7 +371,7 @@ $module_conf->set(
);
```
#### db($db_name : string) : int
Is used to get database index by associated identifier, as it is described in *meta.json* section of [Module architecture](/docs/Module-architecture).
Is used to get database index by associated identifier, as it is described in *meta.json* section of [Module architecture](/docs/Module-architecture.md).
```php
<?php
$Config = \cs\Config::instance();
@@ -383,7 +383,7 @@ $result = $db->$users_db_id->q(
);
```
#### storage($storage_name : string) : int
Is used to get storage index by associated identifier, as it is described in *meta.json* section of [Module architecture](/docs/Module-architecture).
Is used to get storage index by associated identifier, as it is described in *meta.json* section of [Module architecture](/docs/Module-architecture.md).
```php
<?php
$Config = \cs\Config::instance();
@@ -16,13 +16,13 @@ $Event = \cs\Event::instance();
* fire()

#### on($event : string, $callback : callable) : bool
Subscribing for event. [More details, and example of use](/docs/Events#wiki-subscribing)
Subscribing for event. [More details, and example of use](/docs/Events.md#wiki-subscribing)

#### off($event : string, $callback : callable) : bool
Unsubscribing from event. [More details, and example of use](/docs/Events#wiki-subscribing)
Unsubscribing from event. [More details, and example of use](/docs/Events.md#wiki-subscribing)

#### once($event : string, $callback : callable) : bool
Subscribing for event for single execution. [More details, and example of use](/docs/Events#wiki-subscribing)
Subscribing for event for single execution. [More details, and example of use](/docs/Events.md#wiki-subscribing)

#### fire($event : string, $param1 = null : mixed|null, $_ = null : mixed|null) : bool
Dispatching of event. [More details, and example of use](/docs/Events#wiki-dispatching)
Dispatching of event. [More details, and example of use](/docs/Events.md#wiki-dispatching)
@@ -1 +1 @@
Deprecated, use [$Event](/docs/$Event) instead
Deprecated, use [$Event](/docs/$Event.md) instead
@@ -143,7 +143,7 @@ This allows to provide custom, more complex processing of input data.
#### `ml:` prefix and `$this->data_model_ml_group`
It is possible to prefix `text` and `html` types with `ml:` to specify that this field is multilingual.

In such case this field will be automatically by `cs\Text` (about [cs\Text class](/docs/$Text)).
In such case this field will be automatically by `cs\Text` (about [cs\Text class](/docs/$Text.md)).

To work with this prefix `$this->data_model_ml_group` protected property should be created.

@@ -153,7 +153,7 @@ Multilingual group and label are composed in such way:

All this multilingual operations works on all methods (creation, reading, updating and deletion) of this trait.

`[prefix]texts` and `[prefix]texts_data` tables are assumed to be present in the same DB returned by `$this->cdb()` method (about `$this->cdb()` in [cs\DB\Accessor trait](/docs/$db#accessor-trait)).
`[prefix]texts` and `[prefix]texts_data` tables are assumed to be present in the same DB returned by `$this->cdb()` method (about `$this->cdb()` in [cs\DB\Accessor trait](/docs/$db.md#accessor-trait)).

#### Joined tables
This is more difficult type, but much more powerful as well.
@@ -1,6 +1,6 @@
CleverStyle CMS doesn't have any CSS/UI framework bundled with it, since they are often not flexible enough and cause significant overhead.

Instead, system comes with CleverStyle Widgets, which is set of useful custom elements that work nicely with Shadow DOM, ready for convenient data bindings and doesn't enforce any appearance by default (namely, almost no styling by default, just support for many [CSS mixins](https://www.polymer-project.org/1.0/docs/devguide/styling.html#custom-css-mixins), so you can style them the way you need).
Instead, system comes with CleverStyle Widgets, which is set of useful custom elements that work nicely with Shadow DOM, ready for convenient data bindings and doesn't enforce any appearance by default (namely, almost no styling by default, just support for many [CSS mixins](https://www.polymer-project.org/1.0/docs/devguide/styling.html.md#custom-css-mixins), so you can style them the way you need).

CleverStyle Widgets includes following elements:
* `cs-button`
@@ -280,7 +280,7 @@ Progress bar.

Attributes (also available as properties, so use whatever is more convenient):
* infinite - boolean, infinite progress bar
* text-progress - whether show text with percents inside progress bar (Chromium only)
* text-progress - whether show text with percents inside progress bar (Chromium only)
* value - number, attribute only (not working as property!), current progress 0..100%

Properties:
@@ -30,7 +30,7 @@ Comments with less importance may be one-line comments started with `//`, but it
* Comment here
*/
```
When writing documentation, please use [PHPDocumentor’s](http://www.phpdoc.org/docs/latest/for-users/phpdoc-reference.html) or [JSDoc](https://en.wikipedia.org/wiki/JSDoc) syntax.
When writing documentation, please use [PHPDocumentor’s](http://www.phpdoc.org/docs/latest/for-users/phpdoc-reference.html.md) or [JSDoc](https://en.wikipedia.org/wiki/JSDoc) syntax.

#### Spaces and wrapping
Indentation should consist of 1 tab. 1 tab = 4 spaces (should be configured in you editor's settings).
@@ -132,7 +132,7 @@ All ids and classes must start with `cs`, components must add their namespace in

#### Classes and functions vs. plain code
File should either declare class of functions or cause side-effect, not both at the same file.
There may be several functions in the same file, but there should be only one class to work properly with classes autoloading.
There may be several functions in the same file, but there should be only one class to work properly with classes autoloading.

#### Web Components
Names of Web Components elements should start with `cs-` also and contain component name in logs or short form, or use some other prefix without `cs-`:
@@ -1,4 +1,4 @@
Components dependencies are specified in `meta.json` file of [module](/docs/Module-architecture#metajson) or [plugin](/docs/Plugin-architecture#metajson), for instance:
Components dependencies are specified in `meta.json` file of [module](/docs/Module-architecture.md#metajson) or [plugin](/docs/Plugin-architecture.md#metajson), for instance:
```json
{
"package" : "Blogs",
@@ -73,7 +73,7 @@ Reduced example:
```
In this example `Main_module_patch` component extends `Main_module`, technically behavior is the same as in case if `Main_module` have optional dependency on `Main_module_patch` with only difference that you don't have to specify any dependencies in `Main_module`.

This is especially handy for [Polymer elements extension](/docs/Polymer-elements-extension), when there can be any custom components that extend other (see below section **JS/CSS/HTML inclusion**). Because you have such flexible dependency you can extend components multiple times without having any conflicts between components.
This is especially handy for [Polymer elements extension](/docs/Polymer-elements-extension.md), when there can be any custom components that extend other (see below section **JS/CSS/HTML inclusion**). Because you have such flexible dependency you can extend components multiple times without having any conflicts between components.

Also, you can extend not only by component name, but also by functionality, just like with direct dependencies.

@@ -35,9 +35,9 @@ Then add remote `upstream` repository, so that you'll have quick access to lates
git remote add upstream git@github.com:nazar-pc/CleverStyle-CMS.git
```

[Now build distributive](/docs/Installer-builder)
[Now build distributive](/docs/Installer-builder.md)

[Now install system](/docs/Installation) to the same directory
[Now install system](/docs/Installation.md) to the same directory

Afterwards run:
```
@@ -4,7 +4,7 @@ Nightly builds represent bleeding edge state of system and components, is update
### [Stable builds](https://sourceforge.net/projects/cleverstyle-cms/files/stable/)
Stable builds are based on releases, they are more stable, but always much older that nightly builds, recommended for production environments.

Please, read [how to install](/docs/Installation) it properly depending on your environment
Please, read [how to install](/docs/Installation.md) it properly depending on your environment

### Digital signature
All new builds starting from version `2.28.0+build-1076` are digitally signed.
@@ -3,7 +3,7 @@
Event = window.cs.Event;
```

Object is the similar to [$Event](/docs/$Event) object on backend, see [examples](/docs/Events).
Object is the similar to [$Event](/docs/$Event.md) object on backend, see [examples](/docs/Events.md).

### [Methods](#methods)

@@ -17,17 +17,17 @@ Object is the similar to [$Event](/docs/$Event) object on backend, see [examples
* fire()

#### on(event : string, callback : function) : cs.Event
Subscribing for event. [More details, and example of use](/docs/Events#wiki-subscribing)
Subscribing for event. [More details, and example of use](/docs/Events.md#wiki-subscribing)
Callback might either return boolean value or Promise object.

#### off(event : string, callback : function) : cs.Event
Unsubscribing from event. [More details, and example of use](/docs/Events#wiki-subscribing)
Unsubscribing from event. [More details, and example of use](/docs/Events.md#wiki-subscribing)
Callback might either return boolean value or Promise object.

#### once(event : string, callback : function) : cs.Event
Subscribing for event for single execution. [More details, and example of use](/docs/Events#wiki-subscribing)
Subscribing for event for single execution. [More details, and example of use](/docs/Events.md#wiki-subscribing)
Callback might either return boolean value or Promise object.

#### fire(event : string, callback : function) : Promise
Dispatching of event. [More details, and example of use](/docs/Events#wiki-dispatching)
Dispatching of event. [More details, and example of use](/docs/Events.md#wiki-dispatching)
Will return Promise object, since event handlers might be asynchronous.
@@ -1,6 +1,6 @@
To install CleverStyle CMS you have to have installation package, which has extension **\*.phar.php**.

Latest build of installer may be found on [downloads page](/docs/Download-installation-packages) of this repository or you can [prepare your own](/docs/Installer-builder) installation package.
Latest build of installer may be found on [downloads page](/docs/Download-installation-packages.md) of this repository or you can [prepare your own](/docs/Installer-builder.md) installation package.

### GUI way
Put installer to the root directory of future website. And open this file from web browser.
@@ -13,7 +13,7 @@ For example:
* Fill several fields and click **Install**
* That's it! You have installed CleverStyle CMS

If you are using Nginx - here is [Nginx config sample](/docs/Nginx-config-sample) with necessary configuration for installation and usage.
If you are using Nginx - here is [Nginx config sample](/docs/Nginx-config-sample.md) with necessary configuration for installation and usage.

### CLI way
Alternative way to install CleverStyle CMS is by using command line.
@@ -8,7 +8,7 @@ L = window.cs.Language(prefix);
```
In case of prefixed usage full keys are still available, but prefixed keys are preferred in case of conflict.

Object is similar to [$L](/docs/$L) object on backend, but have less number of methods.
Object is similar to [$L](/docs/$L.md) object on backend, but have less number of methods.

`L` is used only because it is short for frequent usage

@@ -288,7 +288,7 @@ Other possible properties are:
* optional
* conflict

[Read about dependencies and conflicts](/docs/Components-dependencies-and-conflicts)
[Read about dependencies and conflicts](/docs/Components-dependencies-and-conflicts.md)

##### More about `db` property
Contains array with identifiers for databases. If some tables of module can be completely separated, it may be useful to use different identifiers. In such case if you have several configured databases in system (physically separated, or even with different engines, which is more reliable for some data), every identifier may be connected with any existing configured database.
@@ -320,4 +320,4 @@ $result = $Storage->$users_storage_id->file_put_contents('test', 123);
Readme file with extended description of module and some other additional information.

#### events.php
This file is included on every page, even when module is not installed or enabled. It is used mainly for [events subscribing](/docs/Events#wiki-subscribing), but also may be used for other purposes.
This file is included on every page, even when module is not installed or enabled. It is used mainly for [events subscribing](/docs/Events.md#wiki-subscribing), but also may be used for other purposes.
Oops, something went wrong.

0 comments on commit d72acba

Please sign in to comment.