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

Style Preset - Menustyle #170

Open
thexmanxyz opened this issue Apr 30, 2018 · 2 comments
Open

Style Preset - Menustyle #170

thexmanxyz opened this issue Apr 30, 2018 · 2 comments

Comments

@thexmanxyz
Copy link
Contributor

thexmanxyz commented Apr 30, 2018

In advance to the issue #2213 it might be useful to also post the documentation confusion here and so I do now.

It's still not clear if the menustyle for a presets.yaml file is actually part of the framework. See also the documentation here where it's stated:

http://docs.gantry.org/gantry5/advanced/creating-style-presets

Please take further information from the original issue from the link above. If this attribution is not part of the framework it should be removed from the documentation.

@mahagr
Copy link
Member

mahagr commented Jul 4, 2018

@RyanMPierson We may want to tweak the documentation a bit to say that the available variables are fully defined by the theme and if you define a new variable, you need to use it in your own SCSS files in order to them to have any effect.

@thexmanxyz
Copy link
Contributor Author

thexmanxyz commented Jul 22, 2018

@mahagr @RyanMPierson First of all thanks for integrating the documentation change. The newly added information is just fine and should also help people in the long run:

The variables listed in the layout presets are defined entirely by the theme, and are not core to Gantry. If you wish to define a new variable, you need to use it in your own SCSS files in order to them to have any effect.

But that still doesn't cover the actual issue I stated. In both of the default and free available themes (Helium / Hydrogen), which are part of Gantry on Github, there is no menustyle variable available but it is still listed in the docs.

It might be used in the paid themes of RocketTheme. TBH IDK what exact attributes listed under Anatomy of the YAML file are really part of the free themes. You know better which of the variables listed under:

Here is a quick breakdown of the main settings and what they do:

are actually part of the open source themes and which are not. I would either state in that table which ones are really available within Hydrogen / Helium or otherwise remove them completely from this documentation page (e.g. in case of the menustyle). Hope this post clear up the actual issue I have with the variables listed on the bottom of the docs page and within the YAML snippet.

It's somewhat inconsistent and confusing because the rest of the docs is also focused on the open source themes and don't touches things that aren't available. How you actually communicate that is up to you but I just can say it confuses people as it currently is and still needs some rework or more information.

/please reopen

@mahagr mahagr reopened this Jul 31, 2018
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

3 participants