Skip to content

Commit f33491a

Browse files
authored
adjust some docs (dachcom-digital#242)
* adjust some docs * adjust some docs
1 parent 45ba7b4 commit f33491a

9 files changed

+101
-92
lines changed

README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,13 @@ return [
5050
- removes the default `pimcore_area_*` element wrapper from each brick
5151

5252
## And what's not?
53-
- It's not an Avada Theme. While the Toolbox provides some basic Javascript for you, you need to implement and mostly modify them by yourself.
54-
- Toolbox supports only the twig template engine, so there is no way to activate the php template engine (and there will never be such thing).
53+
It's not an Avada Theme. While the Toolbox provides some basic Javascript for you, you need to implement and mostly modify them by yourself.
5554

5655
**Frontend JS Implementation**
5756
We're providing some helpful Javascript Plugins to simplify your daily work with the ToolboxBundle.
5857
Read more about the javascript implementation [here](docs/80_Javascript.md).
5958

6059
## Available Toolbox Bricks
61-
6260
The Toolbox provides a lot of [ready-to-use Bricks](docs/11_ElementsOverview.md):
6361

6462
- Accordion

UPGRADE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
- Recommended folder structure by symfony adopted
5050
- All folders and sub-folders in views are lowercase/underscore now (areas/accordion/accordion_tab, areas/google_map, areas/iframe, areas/link_list, areas/parallax_container, areas/parallax_container_section, areas/parallax_container_section, areas/slide_columns)
5151
- All snippet views are underscore now (snippet_layout.html.twig, snippet/teaser_default, snippet/layout/teaser_layout) - check your views for includes!
52-
- All views are lowercase/underscore now (areas/video/type_*, areas/google_map/info_window, parallax_container/partial/*, parallax_container/wrapper/container_wrapper)
52+
- All views are lowercase/underscore now (areas/video/type_\*, areas/google_map/info_window, parallax_container/partial/\*, parallax_container/wrapper/container_wrapper)
5353
- `dynamiclink` feature has finally been removed! If you're still using it, stay on v4 and [migrate first](https://github.com/dachcom-digital/pimcore-toolbox/blob/3.x/docs/70_ConfigurationFlags.md#-use_dynamic_links-flag)
5454

5555
### WYSIWYG Config Changes

docs/11_ElementsOverview.md

+77-77
Large diffs are not rendered by default.

docs/1_CodeStyle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ toolbox:
2626
```
2727

2828
### Underscore Exceptions
29-
- Google Maps Element, Map Options: Values must to be camelcase because of the google map configuration mapping.
29+
- Google Maps Element, Map Options: Values must be camelcase because of the Google map configuration mapping.
3030
- Config Elements `config` Tree: Values must be camelcase because of the pimcore element configuration mapping.
3131

3232
### Strings

docs/31_OverridingViews.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Overriding Views
2-
32
Symfony allows to override every view and so does this Bundle.
43

54
**Important:** Never! override templates from `@Toolbox/areas/*.html.twig`, always use the views from `@Toolbox/Toolbox/[LAYOUT]/*.html.twig`.

docs/50_FrontendTips.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Gallery / Slider
44
Yes, there are a lot of slider out there.
5-
The ToolboxBundles has some references to the [slick slider](http://kenwheeler.github.io/slick/) so we'll show you some things to consider if you want to us it too:
5+
Toolbox has some references to the [slick slider](http://kenwheeler.github.io/slick/) so we'll show you some things to consider if you want to use it too:
66

77
#### Backend
88
There are three options you need to take care about, otherwise you'll run into some troubles if your opening your document in editmode:

docs/60_ColumnAdjuster.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ toolbox:
3131
3232
## Parameter
3333
34-
| Name | Type | Description
35-
|------|------|------------|
36-
| `grid_size` | integer | Max Grid Columns (Default 12 in Bootstrap) |
37-
| `breakpoints` | array | Your Grid Breakpoints. **Important (!)**: The Column Adjuster is mobile first! Always start your array with the smallest breakpoint! Otherwise the automatic class inheritance won't work! |
34+
| Name | Type | Description |
35+
|---------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
36+
| `grid_size` | integer | Max Grid Columns (Default 12 in Bootstrap) |
37+
| `breakpoints` | array | Your Grid Breakpoints. **Important (!)**: The Column Adjuster is mobile first! Always start your array with the smallest breakpoint! Otherwise the automatic class inheritance won't work! |

docs/70_ConfigurationFlags.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ To avoid this and keep the backward compatibility promise, we've implemented the
66
***
77

88
Currently, no configuration flags available.
9-
> If you're updating from 2.x/3.x to 4.x please check out old configuration flags (https://github.com/dachcom-digital/pimcore-toolbox/blob/3.x/docs/70_ConfigurationFlags.md) first!
9+
> If you're updating from 2.x/3.x to 4.x please check out old configuration flags (https://github.com/dachcom-digital/pimcore-toolbox/blob/3.x/docs/70_ConfigurationFlags.md) first!

docs/80_Javascript.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
# Javascript Plugins
2+
We're providing some helpful Javascript Plugins to simplify your daily work with Toolbox.
3+
4+
***
5+
6+
## VanillaJs
7+
All Extensions are available on npmjs.com via [js-pimcore-toolbox](https://www.npmjs.com/package/js-pimcore-toolbox).
8+
9+
### Installation
10+
```bash
11+
npm i js-pimcore-toolbox
12+
```
13+
14+
Read more about installation and usage on [github](https://github.com/dachcom-digital/js-pimcore-toolbox).
15+
16+
***
217

318
## Jquery
419
All jQuery Extensions are available on npmjs.com via [jquery-pimcore-toolbox](https://www.npmjs.com/package/jquery-pimcore-toolbox).
@@ -9,6 +24,3 @@ npm i jquery-pimcore-toolbox
924
```
1025

1126
Read more about installation and usage on [github](https://github.com/dachcom-digital/jquery-pimcore-toolbox).
12-
13-
## Alpine.js
14-
TBD

0 commit comments

Comments
 (0)