Skip to content
This repository was archived by the owner on Dec 1, 2023. It is now read-only.

Commit a6637da

Browse files
author
Florian
committed
New structure for cleaner URLs.
1 parent 7e3c0a7 commit a6637da

40 files changed

+94
-94
lines changed

Diff for: README.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,30 @@ This is the documentation for [Pagekit](https://pagekit.com), a modular open sou
2121
8. [Finder](user-interface/finder.md)
2222

2323
- Tutorials
24-
1. [How to: Extension](developer-guides/extension.md)
25-
2. [How to: Theme](developer-guides/how-to-theme.md)
26-
3. [Themes](developer-guides/themes.md)
27-
4. [Widgets](developer-guides/widgets.md)
28-
5. [Dashboard Widgets](developer-guides/dashboard-widgets.md)
29-
6. [Translate Pagekit](developer-guides/translation.md)
30-
7. [Marketplace](developer-guides/marketplace.md)
24+
1. [Extension](tutorials/extension.md)
25+
2. [Theme](tutorials/theme.md)
26+
4. [Widgets](tutorials/widgets.md)
27+
5. [Dashboard Widgets](tutorials/dashboard-widgets.md)
28+
6. [Translate Pagekit](tutorials/translation.md)
29+
7. [Marketplace](tutorials/marketplace.md)
3130

3231
- Developer Fundamentals
33-
1. [File Structure](developer-basics/file-structure.md)
34-
1. [Application](developer-basics/application.md)
35-
2. [Packages](developer-basics/packages.md)
36-
3. [Modules](developer-basics/modules.md)
37-
4. [Events](developer-basics/events.md)
38-
5. [Routing](developer-basics/routing.md)
39-
6. [Response](developer-basics/response.md)
40-
7. [Users & Permissions](developer-basics/users-permissions.md)
41-
8. [Views & Templating](developer-basics/views-templating.md)
42-
9. [Vue & Webpack](developer-basics/vuejs-and-webpack.md)
43-
10. [Database](developer-basics/database.md)
44-
11. [ORM](developer-basics/orm.md)
45-
12. [Translation](developer-basics/translation.md)
46-
13. [CLI](developer-basics/cli.md)
47-
14. [Pagekit source](developer-basics/source.md)
32+
1. [File Structure](developer/file-structure.md)
33+
1. [Application](developer/application.md)
34+
2. [Packages](developer/packages.md)
35+
3. [Modules](developer/modules.md)
36+
4. [Events](developer/events.md)
37+
5. [Routing](developer/routing.md)
38+
6. [Response](developer/response.md)
39+
7. [Users & Permissions](developer/users-permissions.md)
40+
8. [Theme](developer/theme.md)
41+
8. [Views & Templating](developer/views-templating.md)
42+
9. [Vue & Webpack](developer/vuejs-and-webpack.md)
43+
10. [Database](developer/database.md)
44+
11. [ORM](developer/orm.md)
45+
12. [Translation](developer/translation.md)
46+
13. [CLI](developer/cli.md)
47+
14. [Pagekit source](developer/source.md)
4848

4949
- Troubleshooting
5050
1. [System Information](troubleshooting/system-information.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Diff for: developer-basics/modules.md renamed to developer/modules.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Nodes are similar to routes with the main difference that they can be dragged ar
198198

199199
When you have added a Node, it will be available in the Site Tree. Click the _Add Page_ button to see the Dropdown of all available Node types.
200200

201-
For more information on nodes, check out the [Routing section](../developer-basics/routing.md).
201+
For more information on nodes, check out the [Routing section](../developer/routing.md).
202202

203203
```php
204204
'nodes' => [
@@ -220,7 +220,7 @@ For more information on nodes, check out the [Routing section](../developer-basi
220220

221221
## Node options
222222

223-
If your module wants to add a configuration screen to the content editor in the Site Tree, you can use the `node` property to add default options to the node object (complete explanation for configuration screen in the [Theme guide](../developer-guides/how-to-theme.md#adding-position-options)).
223+
If your module wants to add a configuration screen to the content editor in the Site Tree, you can use the `node` property to add default options to the node object (complete explanation for configuration screen in the [Theme guide](../tutorials/theme.md#adding-position-options)).
224224

225225

226226
In the following example, a theme defines a `top_style` property which is automatically added to every node object that is rendered. By default, the property will have the value `uk-block-muted`, which is a CSS class that we want to render for the `top` position, in this example.
@@ -241,7 +241,7 @@ When rendering a page in the `template.php` of the theme, you can then access th
241241

242242
With the `node` property, you set the default value for every node. To allow the user to change these values, you will want to add an interface to the admin area (typically in the form of an addition _Theme_ tab when editing a page's content).
243243

244-
To allow the user to change the values of the default widget options that you have defined here, you can add an interface to the admin area. To achieve that, you define a JavaScript component to display the editing screen ([Example](https://github.com/pagekit/example-theme/blob/master/app/components/node-theme.vue)), register that JavaScript file on the content editor page ([Example](https://github.com/pagekit/example-theme/blob/master/index.php#L43)) and optionally update your Webpack configuration, if you are using Webpack ([Example](https://github.com/pagekit/example-theme/blob/master/webpack.config.js#L5)). A complete explanation for this can be found in the [Theme guide](../developer-guides/how-to-theme.md#adding-position-options).
244+
To allow the user to change the values of the default widget options that you have defined here, you can add an interface to the admin area. To achieve that, you define a JavaScript component to display the editing screen ([Example](https://github.com/pagekit/example-theme/blob/master/app/components/node-theme.vue)), register that JavaScript file on the content editor page ([Example](https://github.com/pagekit/example-theme/blob/master/index.php#L43)) and optionally update your Webpack configuration, if you are using Webpack ([Example](https://github.com/pagekit/example-theme/blob/master/webpack.config.js#L5)). A complete explanation for this can be found in the [Theme guide](../tutorials/theme.md#adding-position-options).
245245

246246
## Add menu items to the admin panel
247247
You can add menu items to the admin panel's main navigation. These can link to any registered route and be limited to certain access permissions. The `access` property determines if the menu item is visible or not.
@@ -291,7 +291,7 @@ Link to a route that renders your settings screen. Setting this property makes P
291291
```
292292

293293
## Register Widgets
294-
A Widget is also a module. With the `widgets` property you can register all widget module definition files. Each of those files is expected to return a PHP array in the form of a valid module definition. Learn more about [Widgets](../developer-guides/widgets.md).
294+
A Widget is also a module. With the `widgets` property you can register all widget module definition files. Each of those files is expected to return a PHP array in the form of a valid module definition. Learn more about [Widgets](../tutorials/widgets.md).
295295

296296
```php
297297
'widgets' => [
@@ -303,7 +303,7 @@ A Widget is also a module. With the `widgets` property you can register all widg
303303

304304
## Widget options
305305

306-
If your module wants to add a configuration screen to the Widget editor (which is often the case when developing a theme), you can use the `widget` property to add default options to the widget object (a complete example for a widget configuration screen is in the [Theme guide](../developer-guides/how-to-theme.md#adding-widget-options)).
306+
If your module wants to add a configuration screen to the Widget editor (which is often the case when developing a theme), you can use the `widget` property to add default options to the widget object (a complete example for a widget configuration screen is in the [Theme guide](../tutorials/theme.md#adding-widget-options)).
307307

308308
In the following example, a theme defines a `panel` property which is automatically added to every widget object that is rendered. By default, the property will have the empty string as its value.
309309

@@ -321,4 +321,4 @@ When rendering the widget, you can then access that property from the `$widget->
321321
<?php echo $widget->theme['panel'] ?>
322322
```
323323

324-
To allow the user, to change the values of the default widget options that you have defined here, you can add an interface to the admin area. To achieve that, you define a JavaScript component to display the editing screen ([Example](https://github.com/pagekit/example-theme/blob/master/app/components/widget-theme.vue)), register that JavaScript file on the widget editor page ([Example](https://github.com/pagekit/example-theme/blob/master/index.php#L47)) and optionally update your Webpack configuration, if you are using Webpack ([Example](https://github.com/pagekit/example-theme/blob/master/webpack.config.js#L7)). A complete explanation for this can be found in the [Theme guide](../developer-guides/how-to-theme.md#adding-widget-options).
324+
To allow the user, to change the values of the default widget options that you have defined here, you can add an interface to the admin area. To achieve that, you define a JavaScript component to display the editing screen ([Example](https://github.com/pagekit/example-theme/blob/master/app/components/widget-theme.vue)), register that JavaScript file on the widget editor page ([Example](https://github.com/pagekit/example-theme/blob/master/index.php#L47)) and optionally update your Webpack configuration, if you are using Webpack ([Example](https://github.com/pagekit/example-theme/blob/master/webpack.config.js#L7)). A complete explanation for this can be found in the [Theme guide](../tutorials/theme.md#adding-widget-options).
File renamed without changes.

Diff for: developer-basics/packages.md renamed to developer/packages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ A package contains at least two files.
2020
1. The `composer.json` contains the metadata for your package and therefore acts as the package definition.
2121
2. The `index.php` is a so called [Module definition](modules.md) and adds actual functionality to Pagekit.
2222

23-
The rest of the package content depends on the package's `type`. To learn more about the actual content of a package, check out the [Theme Guide](../developer-guides/themes.md) or the [Extension Guide](../developer-guides/extension.md).
23+
The rest of the package content depends on the package's `type`. To learn more about the actual content of a package, check out the [Theme Guide](../tutorials/theme.md) or the [Extension Guide](../tutorials/extension.md).
2424

2525
## Package definition
2626
A package is defined by its `composer.json`. This file includes the package name, potential dependencies to be installed by [Composer](https://getcomposer.org) and other information that displays in the Pagekit marketplace.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Diff for: developer-guides/themes.md renamed to developer/theme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</ul>
1818

1919
## Package definition
20-
A theme is a regular Pagekit [package](../developer-basics/packages.md) of the type `pagekit-theme`. Each package needs a description in order to be recognized by Pagekit. This description is located in the `composer.json` file and looks as follows. For detailed information, take a look the [Packages](../developer-basics/packages.md) chapter.
20+
A theme is a regular Pagekit [package](../developer/packages.md) of the type `pagekit-theme`. Each package needs a description in order to be recognized by Pagekit. This description is located in the `composer.json` file and looks as follows. For detailed information, take a look the [Packages](../developer/packages.md) chapter.
2121

2222
```json
2323
{
@@ -29,7 +29,7 @@ A theme is a regular Pagekit [package](../developer-basics/packages.md) of the t
2929
```
3030

3131
## Module definition
32-
A theme in itself is simply a [module](../developer-basics/modules.md). So you may want to read up on modules first. This opens up a lot of possibilities with regard to what a theme can do.
32+
A theme in itself is simply a [module](../developer/modules.md). So you may want to read up on modules first. This opens up a lot of possibilities with regard to what a theme can do.
3333

3434
Define the positions and menus of your theme, load additional scripts and much more. Here is a shortened example of the `index.php` to get you started. Explanations of the theme specific properties follow below.
3535

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Diff for: getting-started/introduction.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ Depending on your goals with Pagekit you might want to read only pieces of the d
66

77
1. Pagekit [installation](installation.md), [requirements](requirements.md) and places to [find help](../getting-started/getting-help.md) if you are stuck.
88
2. Learn how to use the Pagekit [user interface](../user-interface/dashboard.md).
9-
3. To get started as a developer, learn [how to create an extension](../developer-guides/extension.md) and [how to build a theme](../developer-guides/themes.md).
10-
4. For a complete video guide on building an extension, watch [the screencast about an example extension](../developer-guides/extension.md).
11-
5. For more fundamental developer topics, read up on e.g. [packages](../developer-basics/packages.md), [modules](../developer-basics/packages.md) and [packages](../developer-basics/routing.md).
9+
3. To get started as a developer, learn [how to create an extension](../tutorials/extension.md) and [how to build a theme](../tutorials/theme.md).
10+
4. For a complete video guide on building an extension, watch [the screencast about an example extension](../tutorials/extension.md).
11+
5. For more fundamental developer topics, read up on e.g. [packages](../developer/packages.md), [modules](../developer/packages.md) and [packages](../developer/routing.md).
File renamed without changes.

Diff for: developer-guides/dashboard-widgets.md renamed to tutorials/dashboard-widgets.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<p class="uk-article-lead">The Dashboard is the first screen that is shown after logging in to the admin panel. It gives an overview of the website and contains multiple Dashboard Widgets. You can create your own Dashboard Widget that can display useful information or offer shortcuts to other areas of your extension.</p>
44

55

6-
A Dashboard Widget is created as a [Vue.js](http://vuejs.org) component. The following example explains how to create the Widget using a webpack configuration in your extension. If you are not sure what Vue.js and Webpack are or how they work together, you might want to read the [Vue.js and Webpack](../developer-basics/vuejs-and-webpack.md) article first.
6+
A Dashboard Widget is created as a [Vue.js](http://vuejs.org) component. The following example explains how to create the Widget using a webpack configuration in your extension. If you are not sure what Vue.js and Webpack are or how they work together, you might want to read the [Vue.js and Webpack](../developer/vuejs-and-webpack.md) article first.
77

88
## Create a Vue component
99

Diff for: developer-guides/extension.md renamed to tutorials/extension.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Every package belongs to a specific vendor name, which becomes clear when you lo
3838
Core packages are part of the `pagekit` namespace and located in the appropriate subdirectory inside `/packages`. Any third party packages (yours!) will have their own vendor name and therefore sit in a separate subfolder.
3939

4040
```
41-
/packages
41+
/packages
4242
/pagekit
4343
/blog
4444
/theme-one
@@ -121,13 +121,13 @@ class TodoController
121121
122122
public function indexAction()
123123
{
124-
return "Yay.";
124+
return "Yay.";
125125
}
126126
127127
}
128128
```
129129

130-
To limit the access to the admin area and mount this controller to an admin url, we use the annotation `@Access(admin=true)`. Annotations are keywords which are placed in the comment block above a class or method. Learn [more about annotations](http://pagekit.com/docs/developer-basics/routing#annotations).
130+
To limit the access to the admin area and mount this controller to an admin url, we use the annotation `@Access(admin=true)`. Annotations are keywords which are placed in the comment block above a class or method. Learn [more about annotations](http://pagekit.com/docs/developer/routing#annotations).
131131

132132
To use this controller, we need to autoload our namespace and mount the controller to a route. Add the following properties to the configuration array in your `index.php`.
133133

@@ -152,7 +152,7 @@ To use this controller, we need to autoload our namespace and mount the controll
152152
// which controller to mount
153153
'controller' => 'Pagekit\\Todo\\Controller\\TodoController'
154154
]
155-
],
155+
],
156156
157157
// ...
158158
```
@@ -205,8 +205,8 @@ To pass parameters to the view renderer, a controller action returns a PHP array
205205

206206
```
207207
public function indexAction()
208-
{
209-
return [
208+
{
209+
return [
210210
'$view' => [
211211
'title' => 'TODO management',
212212
'name' => 'todo:views/admin/index.php'
File renamed without changes.

0 commit comments

Comments
 (0)