-## WoltLab Suite 3.1 Documentation
+## WoltLab Suite 5.2 Documentation
This repository is used to build the documentation at [https://docs.woltlab.com](https://docs.woltlab.com), contributions are welcome.
output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
-topnav_title: WoltLab Suite 3.1 Documentation
+topnav_title: WoltLab Suite 5.2 Documentation
# this appears on the top navigation bar next to the home button
-site_title: WoltLab Suite 3.1 Documentation
+site_title: WoltLab Suite 5.2 Documentation
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
company_name: WoltLab GmbH
entries:
- title: sidebar
product: WoltLab Suite
- version: 3.1
+ version: 5.2
folders:
- title: Getting Started
---
-title: WoltLab Suite 3.1 Documentation
+title: WoltLab Suite 5.2 Documentation
sidebar: sidebar
permalink: index.html
toc: false
Head over to the [quick start tutorial][getting-started_quick-start] to learn more.
-## About WoltLab Suite 3.1
+## About WoltLab Suite 5.2
The [WoltLab Suite Core](https://github.com/WoltLab/WCF) as well as most of the other packages are available on [github.com/WoltLab/](https://github.com/WoltLab) and are licensed under the terms of the [GNU Lesser General Public License 2.1](https://github.com/WoltLab/WCF/blob/master/LICENSE).
## Introduction
-WoltLab Suite 3.0 and 3.1 ship with a set of global helper functions that are
+Since version 3.0, WoltLab Suite ships with a set of global helper functions that are
exposed on the `window`-object and thus are available regardless of the context.
They are meant to reduce code repetition and to increase readability by moving
potentially relevant parts to the front of an instruction.
## Example: Two Text Form Fields
-As the first example, the pre-WoltLab Suite Core 3.2 versions of the forms to add and edit persons from the [first part of the tutorial series](tutorial_tutorial-series_part-1-base-structure.html) will be updated to the new form builder API.
+As the first example, the pre-WoltLab Suite Core 5.2 versions of the forms to add and edit persons from the [first part of the tutorial series](tutorial_tutorial-series_part-1-base-structure.html) will be updated to the new form builder API.
This form is the perfect first examples as it is very simple with only two text fields whose only restriction is that they have to be filled out and that their values may not be longer than 255 characters each.
As a reminder, here are the two relevant PHP files and the relevant template file:
## Form Builder
-WoltLab Suite Core 3.2 introduces a new, simpler and quicker way of creating forms:
+WoltLab Suite Core 5.2 introduces a new, simpler and quicker way of creating forms:
[form builder](php_api_form_builder.html).
You can find examples of how to migrate existing forms to form builder [here](migration_wsc-31_form-builder.html).
folder: php/api
---
-{% include callout.html content="Form builder is only available since WoltLab Suite Core 3.2." type="info" %}
+{% include callout.html content="Form builder is only available since WoltLab Suite Core 5.2." type="info" %}
-{% include callout.html content="The [migration guide for WoltLab Suite Core 3.2](migration_wsc-31_form-builder.html) provides some examples of how to migrate existing forms to form builder that can also help in understanding form builder if the old way of creating forms is familiar." type="info" %}
+{% include callout.html content="The [migration guide for WoltLab Suite Core 5.2](migration_wsc-31_form-builder.html) provides some examples of how to migrate existing forms to form builder that can also help in understanding form builder if the old way of creating forms is familiar." type="info" %}
## Advantages of Form Builder
| `key` | optional template variable name where the current array key is stored during the iteration |
-## <span class="label label-info">3.2+</span> `ipSearch`
+## <span class="label label-info">5.2+</span> `ipSearch`
`ipSearch` generates a link to search for an IP address.
projects / GitHub / WoltLab / woltlab.github.io.git / commitdiff