mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-11-26 05:38:29 +00:00
Fix formatting issues
This commit is contained in:
@@ -1,16 +1,7 @@
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.3
|
||||
or any later version published by the Free Software Foundation;
|
||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||
A copy of the license is included in the section entitled "GNU
|
||||
Free Documentation License".
|
||||
|
||||
# Person bundle
|
||||
|
||||
This bundle provides the ability to record people in the software. This bundle is required by other bundle.
|
||||
|
||||
:local:
|
||||
|
||||
###### Entities provided
|
||||
|
||||
describe entities provided by person bundle
|
||||
@@ -44,6 +35,7 @@ Those options are available under `chill_person` key.
|
||||
|
||||
Example of configuration:
|
||||
|
||||
```yaml
|
||||
chill_person:
|
||||
validation:
|
||||
birthdate_not_after: P15Y
|
||||
@@ -57,6 +49,7 @@ Example of configuration:
|
||||
marital_status: visible
|
||||
spoken_languages: hidden
|
||||
address: visible
|
||||
```
|
||||
|
||||
birthdate_not_after *string*
|
||||
The period duration before today during which encoding birthdate is not possible. The period is a string matching the format of `ISO_8601`, which is also use to build `DateInterval classes ](http://php.net/manual/en/dateinterval.construct.php).
|
||||
@@ -83,7 +76,7 @@ person_fields *array*
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
```yaml
|
||||
chill_person:
|
||||
person_fields:
|
||||
nationality: hidden
|
||||
@@ -104,9 +97,9 @@ Macro file
|
||||
Macro envelope
|
||||
`render(p, withLink=false)`
|
||||
|
||||
`p` is an instance of :class:`Chill\PersonBundle\Entity\Person`
|
||||
`p` is an instance of `Chill\PersonBundle\Entity\Person`
|
||||
|
||||
`withLink` :class:`boolean`
|
||||
`withLink`: `boolean`
|
||||
When to use this macro ?
|
||||
When you want to represent a person.
|
||||
Example usage :
|
||||
@@ -124,7 +117,7 @@ This event is available to add content below of the vertical menu (on the right)
|
||||
|
||||
The context is :
|
||||
|
||||
- `person` : the current person which is rendered. Instance of :class:`Chill\PersonBundle\Entity\Person`
|
||||
- `person` : the current person which is rendered. Instance of `Chill\PersonBundle\Entity\Person`
|
||||
|
||||
###### Widgets
|
||||
|
||||
@@ -132,6 +125,7 @@ The context is :
|
||||
|
||||
The bundle provide a way to add a list of accompanyied person on the homepage:
|
||||
|
||||
```yaml
|
||||
chill_main:
|
||||
widgets:
|
||||
homepage:
|
||||
@@ -152,6 +146,7 @@ The bundle provide a way to add a list of accompanyied person on the homepage:
|
||||
# when the view is overriden, you can add some custom fields
|
||||
# to the view
|
||||
custom_fields: [school-2fb5440e-192c-11e6-b2fd-74d02b0c9b55]
|
||||
```
|
||||
|
||||
###### Commands
|
||||
|
||||
|
||||
Reference in New Issue
Block a user