The Builder plugin is an extended structure field for Kirby CMS. It adopts some ideas from this post in the official kirby forum and gives you the possibility to create an arrange different field sets rather then being limited by only one field set type per structure field.
Here is a blueprint example:
fields:
...
builder:
label: Sections
type: builder
fieldsets:
bodytext:
label: Body Text
fields:
text:
label: text
type: textarea
linkedImage:
label: Linked Image
entry: >
<img src="{{_fileUrl}}{{image}}" height=120px/></br>
{{url}}
fields:
image:
label: Category
type: select
options: images
url:
label: Link Url
type: text
quote:
label: Quote
entry: >
<i>"{{text}}"</i></br></br>
{{citation}}
fields:
text:
label: Quote Text
type: textarea
citation:
label: Citation
type: text
Have a look at _fileUrl. This handy placeholder variable provides the path to the files of the current page and can be used for image previews inside the panel.
The above blueprint will give us a section field like this:
The content will be stored like this:
----
Builder:
-
text: >
Lorem ipsum dolor sit amet, consectetur
adipisicing elit. Ipsa, rerum quam
similique numquam doloremque, quidem
sequi placeat quibusdam aspernatur
doloribus tempore, obcaecati eligendi
odio eaque repellendus accusamus veniam
blanditiis impedit.
_fieldset: bodytext
-
image: forrest.jpg
url: www.getkirby.com
_fieldset: linkedImage
-
text: >
Power is of two kinds. One is obtained
by the fear of punishment and the other
by acts of love. Power based on love is
a thousand times more effective and
permanent then the one derived from fear
of punishment.
citation: Mahadma Gandhi
_fieldset: quote
##Template Usage
There are different ways to use the builder field inside a template. A clean approach for this is to use different snippets inside site/snippets/sections/ that have the same file name like the field set names in the blueprint:
<?php foreach($page->builder()->toStructure() as $section): ?>
<?php snippet( snippet('sections/' . $section->_fieldset(), array('section' => $section)) ) ?>
<?php endforeach ?>Don't forget to use toStructure() on the builder field that "gives you a full blown Kirby Collection which makes it possible to use Kirby's chaining syntax" (Kirby Documentation).
<p><?php echo $section->text()->kt() ?></p><a href="<?php echo $section->url() ?>">
<img src="<?php echo $section->image()->toFile()->url() ?>" alt="section image">
</a><blockquote>
<?php echo $section->text()->kt() ?>
</blockquote>
<p><cite><?php echo $section->citation() ?></cite></p>The plugin comes in two pieces:
- The content of the
fieldsfolder has to be copied intosite/fieldsinside your Kirby installation - The content of the
pluginsfolder has to be copied into `site/plugins inside your Kirby installation
##Known Issues
Builder fields do not support nested fields that require a modal to handle the content, which are structure fields or other builder fields.