Mention checkboxes/radios options pre-setting in forms_api_reference.html

Moving to documetation queue (the file to be edited is in that git repository).

Tagging so #1421874: [meta] Documentation Issue Queue Cleanup doesn't have to look at API docs issues.

tagging

Linking to the Drupal 8 version of this. The patch here could use similar text as that one does.

I am unable to find starting point where I can make changes so that it is reflected in developer/topics/forms_api_reference.html

Unable to find such file "forms_api_reference.html" in drupal 7.x repo. Not sure if I am looking at a right place or not.

Adding patch

Screenshots after applying the patch.

Thank you VERY much @joachim and @sun for pointing out this useful behavior!

Can someone test the code in the proposed changes (see screenshot) and verify that it works correctly in a D7 form? Thanks!

Feel free to add line breaks to the file.

@joachim, I have removed the function "drupal_map_assoc" from docs.
After applying patch.
Radios:

Checkboxes

By splitting the code line up into multiple lines, your patch has added a bunch of whitespace that shouldn't be on the page. For instance, it should look like

t('whatever')

not

t ( 'whatever' ) 

There should not be spaces around the (). Same with [].

Also because of splitting the lines, it is very difficult to look at the patch and see what has actually changed from the old version. It looks like the whole thing is completely different, but it actually isn't.

So... please make a new patch. Thanks!

@jhodgdon, These whitespaces are added due to new line breaks. After removing those new line break it will look like t('whatever')

Eg: https://jsfiddle.net/shashi1028/e1Ltukn8/
Or should I create patch like

<span>1</span><!--
--><span>2</span><!--
--><span>3</span>

to remove spaces.

Yes, I understood that the line breaks generated the extra spaces. Please remove them, rather than adding comments.

Why do I say this? Well, ... It is a general philosophy in the Drupal project as a whole, that patches should only address the actual problem in the issue. So, if you have an issue that says "We should add to this documentation an example showing how to set options", you should make a patch that does just that. Not a patch that also totally reformats that section of the file.

So, if you want to make a patch that reformats a file, you should use a separate issue to do that, not combine it with this issue.

Thanks!

Here is the new patch after removing line breaks.

The patch applied evenly and seems good. Moving it to reviewed.

Just looked and reviewed the D7 form API reference examples. These additions are showing up.

Thanks for working to improve Drupal.

This is for the Drupal 7 Form API reference. Since Drupal 7 is past end-of-life this is now a "won't fix".

Work on documentation for form elements for supported versions of Drupal is at #2486967: [meta] Move/Create Form Element Documentation and #3313535: [Meta] Improve documentation for Render and Form Elements.