Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Documenting missing Form variables #2372

Closed
wouterj opened this Issue Mar 29, 2013 · 1 comment

Comments

Projects
None yet
2 participants
Member

wouterj commented Mar 29, 2013

Some form types got some extra variables or override the common form variables. In fact, those common variables are the variables set on the main form type (Field).

How to document it

These variables should get documented in a new section in each Form Type article. They should get the same format as the Form Type Options. Inherit options should not get documented, as those are already documented in reference/form/twig_reference.

The form variables

The variables link to the code where they are defined. Try to find out a use case of it and possible values and write some small description about those (with some link to the option which is used for the variable). A code example would be great too!

Checkbox

Choice

Collection

DateTime

Date

Money

Radio

Time

@wouterj wouterj added the hasPR label Feb 19, 2014

weaverryan added a commit that referenced this issue Mar 9, 2014

feature #3588 Documented all form variables (WouterJ)
This PR was merged into the 2.3 branch.

Discussion
----------

Documented all form variables

| Q   | A
| --- | ---
| Doc fix? | no
| New docs? | yes
| Applies to | 2.3+
| Fixed tickets | #2372

This PR adds all missing global form variables to the twig reference.

Besides that, it also introduces a new section for form types: Form
Variables. This explains what kind of variables are available for that
particular field. This is usefull if you want to create a custom theme.

At last, it also adds the missing docs for the `selectedchoice` Twig
test.

Commits
-------

7710429 Made full stop usage consistent
398d23f Applied comments by @xabbuh
97d216d Documented TimeType variables
8b5ecf9 Documented SubmitType variables
688409e Documented MoneyType variables
a811833 Documented FileType variables
e5fded9 Documented date_pattern variable of DateType
1a1497c Extracted duplicated var tables
95540ca Documented Date(Time)Type variables
3bfdc20 Documented CollectionType variables
754da30 Added performance tip
7d10315 Documented selectedchoice test
c8a44ae Documented choice variables
98e828f Documented checked variable
d2b57be Documented missing FormType variables

@wouterj wouterj closed this Mar 9, 2014

Member

weaverryan commented Mar 9, 2014

An old, big ticket closed - awesome :) - great work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment