You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 1, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: developer/modules.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -198,7 +198,7 @@ Nodes are similar to routes with the main difference that they can be dragged ar
198
198
199
199
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.
200
200
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).
202
202
203
203
```php
204
204
'nodes' => [
@@ -220,7 +220,7 @@ For more information on nodes, check out the [Routing section](../developer-basi
220
220
221
221
## Node options
222
222
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)).
224
224
225
225
226
226
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
241
241
242
242
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).
243
243
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).
245
245
246
246
## Add menu items to the admin panel
247
247
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
291
291
```
292
292
293
293
## 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).
295
295
296
296
```php
297
297
'widgets' => [
@@ -303,7 +303,7 @@ A Widget is also a module. With the `widgets` property you can register all widg
303
303
304
304
## Widget options
305
305
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)).
307
307
308
308
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.
309
309
@@ -321,4 +321,4 @@ When rendering the widget, you can then access that property from the `$widget->
321
321
<?php echo $widget->theme['panel'] ?>
322
322
```
323
323
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).
Copy file name to clipboardExpand all lines: developer/packages.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ A package contains at least two files.
20
20
1. The `composer.json` contains the metadata for your package and therefore acts as the package definition.
21
21
2. The `index.php` is a so called [Module definition](modules.md) and adds actual functionality to Pagekit.
22
22
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).
24
24
25
25
## Package definition
26
26
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.
Copy file name to clipboardExpand all lines: developer/theme.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@
17
17
</ul>
18
18
19
19
## 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.
21
21
22
22
```json
23
23
{
@@ -29,7 +29,7 @@ A theme is a regular Pagekit [package](../developer-basics/packages.md) of the t
29
29
```
30
30
31
31
## 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.
33
33
34
34
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.
Copy file name to clipboardExpand all lines: getting-started/introduction.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,6 @@ Depending on your goals with Pagekit you might want to read only pieces of the d
6
6
7
7
1. Pagekit [installation](installation.md), [requirements](requirements.md) and places to [find help](../getting-started/getting-help.md) if you are stuck.
8
8
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).
Copy file name to clipboardExpand all lines: tutorials/dashboard-widgets.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
<pclass="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>
4
4
5
5
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.
Copy file name to clipboardExpand all lines: tutorials/extension.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ Every package belongs to a specific vendor name, which becomes clear when you lo
38
38
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.
39
39
40
40
```
41
-
/packages
41
+
/packages
42
42
/pagekit
43
43
/blog
44
44
/theme-one
@@ -121,13 +121,13 @@ class TodoController
121
121
122
122
public function indexAction()
123
123
{
124
-
return "Yay.";
124
+
return "Yay.";
125
125
}
126
126
127
127
}
128
128
```
129
129
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).
131
131
132
132
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`.
133
133
@@ -152,7 +152,7 @@ To use this controller, we need to autoload our namespace and mount the controll
0 commit comments