Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the Theme Creation page to include information about the Hidden key #159

Open
philsward opened this issue Oct 22, 2021 · 1 comment

Comments

@philsward
Copy link

philsward commented Oct 22, 2021

See backdrop/backdrop-issues#5321 for context of this issue

On the theme creation document page under the Contents section, there needs to be a new "key" for the hidden flag.

I would place this section between: base theme & theme settings

Copy & Paste (or edit for use)

Visibility Setting

hidden = false

The visibility key setting allows the theme to be shown or hidden from the administrative view list page. This will help by removing themes that don't need to be exposed or changed through the GUI. This is a Boolean setting which means options for this are either true or false. This is an optional setting, however if you are creating a contributed theme, it is recommended to always make sure this is added to the .info file for best consistency. The default for this setting is false if the key is missing or true if the key is present with no value.


See backdrop/backdrop-issues#5329 for details on what the actual "default" workflow is supposed to be... It's either an odd workflow by design or an incorrect workflow that needs fixed.

Update 2021-10-28: Some eyes were able to look at #5329 and it is agreed that a null value should act the same as no value, therefore the default statement should read something like: "The default for this setting is false if the key is missing or the value is anything other than true."


Rhetorical question: Are there any other areas where this needs to be documented and hasn't been?

@philsward philsward changed the title Update the Theme Creation page to include information about the Hidden flag Update the Theme Creation page to include information about the Hidden key Oct 22, 2021
@philsward
Copy link
Author

It appears this is documented in the modules portion of docs: https://docs.backdropcms.org/creating-modules#info-files (search for hidden)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant