Skip to content

Commit

Permalink
adjust some docs (#242)
Browse files Browse the repository at this point in the history
* adjust some docs

* adjust some docs
  • Loading branch information
solverat authored Jan 8, 2025
1 parent 45ba7b4 commit f33491a
Show file tree
Hide file tree
Showing 9 changed files with 101 additions and 92 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,13 @@ return [
- removes the default `pimcore_area_*` element wrapper from each brick

## And what's not?
- 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.
- 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).
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.

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

## Available Toolbox Bricks

The Toolbox provides a lot of [ready-to-use Bricks](docs/11_ElementsOverview.md):

- Accordion
Expand Down
2 changes: 1 addition & 1 deletion UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
- Recommended folder structure by symfony adopted
- 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)
- All snippet views are underscore now (snippet_layout.html.twig, snippet/teaser_default, snippet/layout/teaser_layout) - check your views for includes!
- All views are lowercase/underscore now (areas/video/type_*, areas/google_map/info_window, parallax_container/partial/*, parallax_container/wrapper/container_wrapper)
- All views are lowercase/underscore now (areas/video/type_\*, areas/google_map/info_window, parallax_container/partial/\*, parallax_container/wrapper/container_wrapper)
- `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)

### WYSIWYG Config Changes
Expand Down
154 changes: 77 additions & 77 deletions docs/11_ElementsOverview.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/1_CodeStyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ toolbox:
```

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

### Strings
Expand Down
1 change: 0 additions & 1 deletion docs/31_OverridingViews.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Overriding Views

Symfony allows to override every view and so does this Bundle.

**Important:** Never! override templates from `@Toolbox/areas/*.html.twig`, always use the views from `@Toolbox/Toolbox/[LAYOUT]/*.html.twig`.
2 changes: 1 addition & 1 deletion docs/50_FrontendTips.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Gallery / Slider
Yes, there are a lot of slider out there.
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:
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:

#### Backend
There are three options you need to take care about, otherwise you'll run into some troubles if your opening your document in editmode:
Expand Down
8 changes: 4 additions & 4 deletions docs/60_ColumnAdjuster.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ toolbox:
## Parameter
| Name | Type | Description
|------|------|------------|
| `grid_size` | integer | Max Grid Columns (Default 12 in Bootstrap) |
| `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! |
| Name | Type | Description |
|---------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `grid_size` | integer | Max Grid Columns (Default 12 in Bootstrap) |
| `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! |
2 changes: 1 addition & 1 deletion docs/70_ConfigurationFlags.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ To avoid this and keep the backward compatibility promise, we've implemented the
***

Currently, no configuration flags available.
> 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!
> 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!
18 changes: 15 additions & 3 deletions docs/80_Javascript.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
# Javascript Plugins
We're providing some helpful Javascript Plugins to simplify your daily work with Toolbox.

***

## VanillaJs
All Extensions are available on npmjs.com via [js-pimcore-toolbox](https://www.npmjs.com/package/js-pimcore-toolbox).

### Installation
```bash
npm i js-pimcore-toolbox
```

Read more about installation and usage on [github](https://github.com/dachcom-digital/js-pimcore-toolbox).

***

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

Read more about installation and usage on [github](https://github.com/dachcom-digital/jquery-pimcore-toolbox).

## Alpine.js
TBD

0 comments on commit f33491a

Please sign in to comment.