There should be something in Gantry 5 documentation that explains the position with Android browsers and what we can and can't support. Or at least some rationale that explains why this is so difficult (e.g.distros, manufacturers, physical devices, lack of updates, etc, etc).

This issue came about because a member reported the mobile menu not working on our demos (2nd level menu) member was using Android 4.1.2 and Firefox for Android 39 (latest). see gantry/gantry5#557

http://docs.gantry.org/gantry5/configure/layout-manager

http://docs.gantry.org/user/pages/01.gantry5/03.configure/04.layout-manager/block_settings_2.png? need an update

and also, please change:
HTML Attributes - This field is where you would add any other HTML attributes to the Block.

as it's now called 'Tag Attributes'

also, please see screenshot, not sure if we want to use 'block' or 'Block' but it should be consistent.

Would be nice to mention that the path for atoms is relative to root of that installation and not to the template's folder

http://docs.gantry.org/gantry5/configure/assignments

http://docs.gantry.org/user/pages/01.gantry5/03.configure/06.assignments/assignments.png

The mobile menu cannot be seen in mobile(Opera mini browser). but you can get the menu by clicking the 'blank space', where the menu should have been displayed. Clicking the blank space shows off- canvas menu

http://docs.gantry.org/gantry5/configure/gantry-admin

the following screenshots also need an update
http://docs.gantry.org/user/pages/01.gantry5/03.configure/01.gantry-admin/configurations.png
http://docs.gantry.org/user/pages/01.gantry5/03.configure/01.gantry-admin/menu_module_1.png
http://docs.gantry.org/user/pages/01.gantry5/03.configure/01.gantry-admin/about.png
http://docs.gantry.org/user/pages/01.gantry5/03.configure/01.gantry-admin/styles.png
http://docs.gantry.org/user/pages/01.gantry5/03.configure/01.gantry-admin/settings.png
http://docs.gantry.org/user/pages/01.gantry5/03.configure/01.gantry-admin/layout.png

The WP tab looks a little bit poor compared to Joomla version on this page : http://docs.gantry.org/gantry5/configure/gantry-admin ;)

I learned how to create a custom.css in my Gantry 4 template for overrides.
Is the process the same in Gantry 5? Do I manually create a custom.css file and if so...is there a special place I need to include it?

Pretty much all screenshots in the Particles section (pages/01.gantry5/03.particles) would like a refreshed screenshot.

There are also new Particles that have been added that might be worth documenting, such as Module Instance

I just added new functions (you may add "since Gantry 5.0.2"):

If you want to add javascript and/or css from your twig file, you can do something like this:

{# Add assets into head of the document by using default priority. #}
{% assets in 'head' with { priority: 0 } %}
    <link rel="stylesheet" href="{{ url('gantry-theme://css/my.css') }}" type="text/css"/>
    <style>
        body {color: red}
    </style>
    <script type="text/javascript" src="{{ url('gantry-theme://js/my.js') }}"></script>
    <script type="text/javascript">
        var MY_VAR = 'test';
    </script>
{% endassets -%}

Basically assets can take two optional parameters:

• in 'x'
• with { priority: y }

where x is the location you want to add your stuff (head and footer are currently supported by Hydrogen theme) and y is priority, which is used to order the assets defaulting to 0 and being in range of -10 ... 10. Priority with higher number gets added into the document before any lower number. If there are multiple assets tags with the same priority their ordering is undefined.

There is also a twig tag for javascript only:

{# Add javascript into end of the document (before any other javascript in the footer). #}
{% scripts in 'footer' with { priority: 10 } %}
    <script type="text/javascript" src="{{ url('gantry-theme://js/footer.js') }}"></script>
    <script type="text/javascript">
        var MY_VAR = 'test';
    </script>
{% endscripts -%}

And for stylesheets only:

{# Add some stylesheets and make them to load last (override other styles). #}
{% styles with { priority: -10 } %}
    <link rel="stylesheet" href="{{ url('gantry-theme://css/my.css') }}" type="text/css"/>
    <style>
        body {color: red}
    </style>
{% endstyles -%}

• 01.gantry5/01.basics/03.installation/docs.md

  1. Installing the Gantry Framework

     We now have also the Gantry 5 Particle module and Gantry 5 - Presets plugin

• 01.gantry5/04.getting-started/docs.md

  1. Navigating the Gantry 5 Administrator

     Screenshot and callouts are outdated

  2. Where to Get Help

     The last paragraph about Documentation is kind of redundant since we already are in the documentation site.

• 01.gantry5/06.updating/docs.md minor

  1. The second screenshot that shows Gantry 5 admin with an update, is outdated.

• 01.gantry5/07.uninstallation/docs.md minor typos

  1. Two lowercase gantry that should be uppercase.

  To uninstall the gantry template, you will [...] that is not gantry [...]
  

• 01.gantry5/08.terminology/docs.md corrections

  1. Outline

     1. "A Outline is essentially a style [...] ➡️ "An Outline is essentially a style [...]"
     2. "The Base Outline acts as the global default by which all other Outlines are based. [...] ➡️ "The Base Outline acts as the global default by which all other unassigned Outlines are based on. [...]
     3. Description on how to create an Outline should also now include the Outlines section within Gantry 5 Admin.

  2. Atom

     1. "[...] such as adding custom scripting you want [...]" ➡️ "[...] such as adding custom JavaScript you want [...]"
     2. "using a special Non-Visual Particles section" ➡️ "using a special Atoms section"

http://docs.gantry.org/gantry5/configure/menu-editor

http://docs.gantry.org/user/pages/01.gantry5/03.configure/05.menu-editor/menu_item_settings.png

• 01.gantry5/02.configure/01.gantry-admin/docs.md

  1. Admin Panels

     1. "[...] you can use the Outline panel to manage [...] ➡️ "[...] you can use the Outlines panel to manage [...]"

  2. Global Admin Panels

     Outlines

     1. The red warning can probably go away at this point?
     2. Screenshot is outdated, it now says "Back to Setup" rather than "Back to Outline"
     3. "These outlines can be edited, but can not be created or renamed, as they are core to Gantry" ➡️ "These outlines can be edited, but can not be created, renamed or deleted, as they are core to Gantry"
     4. Should be mentioned that Outlines can also be renamed from Outline-specific Panels, which is pretty much anywhere in the admin.

     Menu

     1. Screenshot is outdated, it now says "Back to Setup" rather than "Back to Outline"

     About

     1. Screenshot is outdated, it now says "Back to Setup" rather than "Back to Outline" and also the version should match RC3 or any stable release.

  3. Outline-specific Panels

     "[...] In Gantry4, Outlines were referred to as overrides." ➡️ "[...] In Gantry 4, Outlines were referred to as Overrides."

     Styles

     1. Screenshot is outdated. Referencing to "Base Configuration" and missing the collapsible / filters.

     Layout

     1. Screenshot is outdated. We now have a Container wrapper (dark gray) that goes around side-by-side sections (like Main / Sidebar)

     Assignments

     1. "[...]For example, if you have a Outline [...]" ➡️ "[...]For example, if you have an Outline [...]"
• 01.gantry5/02.configure/02.styles/docs.md

  1. Controls

     1. Worths mentioning the Dev/Prod automatic recompilation in here i think?

  2. Theme-specific Settings

     1. The screenshot displays a font for headers that is definitely not Gantry Admin, also outdated because doesn't include the collapse / filters.
     2. "If you are changing these settings for a non-default Configuration [...]" ➡️ "If you are changing these settings for a non-default Outline [...]"
• 01.gantry5/02.configure/03.settings/docs.md

  1. Particle Settings

     1. The screenshot displays a font for headers that is definitely not Gantry Admin, also outdated because doesn't include the collapse / filters.

  2. Atom Settings

     Atom Settings section should go after the Positions Settings, to keep it consistent with the way it looks like in the admin.

     1. The screenshot displays a font for headers that is definitely not Gantry Admin, also outdated because doesn't include the collapse / filters.
     2. "[...] a perfect place for scripted tasks [...]" ➡️ "[...] a perfect place for CSS or JavaScript [...]"

  3. Position Settings

     Position Settings section should go before the Atoms Settings, to keep it consistent with the way it looks like in the admin.

     1. The screenshot displays a font for headers that is definitely not Gantry Admin, also outdated because doesn't include the collapse / filters.
     2. There are two new settings: Module Instance and System Messages
• 01.gantry5/02.configure/04.layout-manager/docs.md

  1. Using the Load Button

     1. "Each outline is assigned a Layout Preset which can be reassigned using the Load button in the Layout Manager. Once you have selected this button, a pop-up will appear with two tabs, Presets and outlines." ➡️ "Each outline is assigned to a Layout Preset which can be reassigned using the Load button in the Layout Manager. Once you have selected this button, a pop-up will appear with two tabs, Presets and Outlines."

  2. Particles

     1. The screenshot is outdated, we now have more particles than the ones displayed.
     2. "[...] is where you will find click-and-dragable Positions, Particles, and Atoms [...] ➡️ "[...] is where you will find draggable Positions, Particles, and Atoms [...]
     3. "[...] simply click and drag it to the [...] ➡️ "[...] simply drag and drop it to the [...]"

  3. Layout

     1. Sections -> Settings

        1. The screenshot is outdated, the fields are more advanced now and we don't have a Defaults button. Description of the fields should also be updated accordingly.

     2. Grids

        1. "[...] In a Grid, you can place Particles, Positions, and Atoms. [...] ➡️ "In a Grid, you can place Positions and Particles, but not Atoms. The Atoms can be only added to the specific Atoms Section at the bottom of the Layout.. [...]"
        2. -> Settings: The screenshot is outdated, the heading fonts was changed as well as the block colors.

     3. Sidebar Blocks and Grids

        1. We are now displaying a container wrapper around side-by-side sections such as Main/Sidebar which allow to set classes/attributes like any other section. It should probably be described and included in the screenshots. Everything described in this section is good, this container is additional and goes wraps the grid. All of this still because of the unique situation.
• 01.gantry5/02.configure/05.menu-editordocs.md

  1. Module/Widget Injection -> Practical Example

     1. First admin screenshot shows a broken language string, doesn't look good.
     2. Second admin screenshot could use a refresh, we now have "Pick a Module" button next to the ID field that makes it easier to change Module.
• 01.gantry5/02.configure/06.assignments/docs.md

  1. Info Note

     1. "Invalid items are marked with the 🚀 icon." -- Are they? Isn't it the switch off icon?

Can you please add a "Renaming the default G5 Template" section in the Documentation, explaining all the steps that need to be performed?

There are many files that need to be edited in order to properly rename it:

1. templateDetails.xml - apart from the general info on the Top, the developer needs to edit line 40 as well:

<fields name="params" addfieldpath="/templates/g5_hydrogen/fields">

Apart from that, should we just delete the <updateservers> section at the bottom if we do not have a live update server?

1. I suppose the language strings in the "install.php" and "..fields/warning.php" should not be edited, should they?
2. "..gantry/theme.yaml" - there are really a lot of instances of the "hydrogen" word. How should we handle this file?
3. Edit all files in the "../blueprints/styles" directory and change the description?
4. Rename the language files in "..language/en-GB" to reflect the template name.
5. And of course, rename the whole "g5_hydrogen" directory.

Guys, such chapter in the Documentation is really needed. Please consider this.

P.S. I'm really interested what you will do with the SCSS files. Will you rename each and every directory and file so it reflects the Template name or you will leave them "Hydrogen"?

I would think this would be easy to know. But in watching the video on the Layout Manager....it doesn't say. Nor can I find it in the documentation.

In the video, there's a section for FEATURE. My question is how do I create a section in my layout for a feature or for a showcase, etc.?

Thanks
Pam

G5 installs into separate directories.
We need to know which file/dir is where.
A G5 directory structure with respect to Joomla installation would be helpful.

Hey guys,

Would you please include detailed instruction for "Preset" creation?
Since it is YAML as well, it is not that obvious (eventhough it is a simple language that describes data) :)

I'm talking about the following:

Basically, the user needs to create a YAML file in the "layouts" folder but there are quite some parameters that need to be explained with as much details and examples as possible. The "Test" preset file is quite simple but in the "home.yaml" file there are some confusing parts :)

Thanks ;)

In Gantry 4 we had this documentation:
http://www.rockettheme.com/docs/joomla/basic/creating_responsive_content.md#custom-responsive-grids

We could do with equivalent documentation for Gantry 5 for those members wishing to create responsive grids within their articles and modules.

Sorry if I missed this somewhere put I couldn't find it.

http://docs.gantry.org/gantry5/configure/extras#development-and-production-modes

The documentation for "production/development" mode should be improved to explain the effect that it has on hash values(asset timestamps) and the "system - Gantry 5" plugin also explain timestamp period and give practical suggestions for usage and good settings. At the moment the docs only say it affects when custom.scss is compiled yet it already does more than this.

Please note that the screen print in the documentation is also out of date as it does not show the timestamp fields (although this might be because perhaps they are only in the CI build?)

Assume we have a Joomla installation with modules of G4 positions.
As you know @Omegatcu has recently added a G4 layout to the G5 dev branch.
Can you please prepare a Youtube video about how we can view G4 modules on this newly-added G5 layout?

A detailed documentation would be helpful on multi-language implementation of G5 after menu rework has been accomplished.

In the main Readme file the following link points at a not existig file.
"We also have a skeleton with all the conventions in place and with many examples of Markdown in use."
The link firefox generates instead:
https://github.com/gantry/docs/blob/develop/Skeleton.md

Hi

in this sentence

You can also add custom images. For example, let's say we have example.png and we want to use it as the preset image. We would place it in /templates/TEMPLATE_DIR/custom/images/admin/layouts and reference it in the YAML file as gantry-media://images/admin/layouts/example.png

gantry-media://images/admin/layouts/example.png

should not be

gantry-media://admin/layouts/example.png

?

Bertrand

When you want to load a preset or outline, disable that check first, will be useful in docs :D

Using the Color Picker tutorial (pages/01.gantry5/04.tutorials/06.using-the-color-picker) needs to be updated to include the new transparent shortcut that sets the current color to transparent while preserving the original hue. This means that later on, the user is able to restore the color by simply dragging back up the handle of the transparency.

http://docs.gantry.org/gantry5/basics/terminology#outline

When creating the custom section.html.twig file, the path should be /templates/TEMPLATE/custom/engines/templates? In the docs it says 'engine', but I needed to create the folder as 'engines' and then it worked. Wasn't sure if it was a typo or not.

http://docs.gantry.org/gantry5/configure/settings

on other pages it says 'Controls' instead of 'Commands', so i think this might need a change?

Like described in the blog post for RC3, we now have a new breakpoint dedicated to the Mobile Menu only. Should probably be included and described in the Using Media Queries tutorial *(pages/01.gantry5/04.tutorials/10.media-queries/docs.md)

http://docs.gantry.org/gantry5/configure/styles

the following screenshots need an update:
http://docs.gantry.org/user/pages/01.gantry5/03.configure/02.styles/controls.png
http://docs.gantry.org/user/pages/01.gantry5/03.configure/02.styles/presets.png

as mentioned on hipchat, something like

http://learn.getgrav.org/troubleshooting/internal-server-error#threadstacksize-on-windows

Creating a New Particle (pages/01.gantry5/05.advanced/01.creating-a-new-particle) has a wrong screenshot in the Creating the YAML File section.

It shouldn't be of a hebe linked template and it should point to the custom folder as described below it.

In the Customizing an Existing Particle section, the "Alternative Duplicate File Directory" should be engine and not engines (TEMPLATE_DIR/custom/engine/particles)

Hey @FrugalGeek ,

There seems to be a typo in the docs - http://docs.gantry.org/gantry5/advanced/creating-layout-presets

system.messages and system.content should be changed to system-messages and system-content. It should be with a dash (-) instead of a dot (.)

http://docs.gantry.org/gantry5/configure/gantry-admin

the following screenshots need an update, they mention 'Gantry 5 Templates' instead of 'Gantry 5 Themes'
http://docs.gantry.org/user/pages/01.gantry5/02.basics/05.updating/gantry_update_1.png
http://docs.gantry.org/user/pages/01.gantry5/03.configure/01.gantry-admin/admin_access_1.png

also, within the text itself, there are a few references to 'Gantry 5 Templates' which need to be updated

http://docs.gantry.org/gantry5/configure/menu-editor

http://docs.gantry.org/user/pages/01.gantry5/03.configure/05.menu-editor/menu_module_1.png
needs an update because of the broken language string of the configuration name

Hi,
I recently started to tanslate the Gantry5 docs to german.

As I'm no prof. translator nor an IT specialist, first of all, I do it for personal use.
But if there is any interest to integrate it in your docs, have a look at https://github.com/max123kl/docs_de_DE

I'm not familar with Markdown and Github so I hesitate to issue a pull-request.

I did rename the repo, cloned it to local, and added a new branch in which the translations are made and pushed it bach to my account.
Are there any further suggestions or advises?
In particular the followin phrase needs a bit additional explanation:
"Every change must pass through the staging branch first, so please ensure your pull-requests are directed to the proper branch."

Guys, would you please add a much more detailed instructions for Particles creation?
Since the Particle is the main building block in Gantry5, it should be very well documented.

Yes, you already have a tutorial in the Advanced section in the Documentation, but for some people who are not very familiar with YAML, it will be quite difficult to create a Particle.

Can you just explain everything with as much details as possible and the most important thing - add more real life examples, meaning add more tutorials explaining who you can create a more advanced Particle. Thanks :)

The Overriding Particle Settings tutorial need to be updated.

Currently it refers to the old "Default Outline" instead of the newer "Base Outline".

Using the Font Picker tutorial pages/01.gantry5/04.tutorials/05.using-the-font-picker/docs.md could benefit from a new section that explains Local Fonts.

You can see how this works with any RT theme, including Hydrogen. It could also cross link to the other advanced section [http://rt.djamil.it/gantry-docs/gantry5/tutorials/fonts]

As a matter of fact, we might consolidate the Fonts tutorials into 1 section. Right now there are 3:

1. Adding a Custom Font
2. Using the Font Picker
3. Adding and Using Fonts

Hello there @FrugalGeek i wrote a tutorial about fixed nav with headroom.js, if you like, feel free to adapt and include it in docs, i am sure there are some grammatical mistakes also, you can also exclude headroom.js part, so will be a simple fixed nav, is up to you.
http://muvingup.com/en/docs/gantry-5/19-gantry-5-fixed-navigation-with-headroom-javascript

Because i see many people on gitter chat, that try to add css code in css-compiled folder and so on. Should be added some warnings in docs don't to this. Don't modify any file in css-compiled folder... things like this you know, just include them as notes, in articles where's needed.

Dear developers and community,

We are all working hard and enjoying Gantry 5 to the fullest. To give everyone the best out of Gantry it would be incredible if all the docs could be translated. Now my aim/idea is to create a group of volunteers to translate the docs as is and to create a separate or combined group of volunteers who want to update the docs.

How Could this work:

Because of the immense amount of work that goes into translations it looks to me to have for every volunteer a minimal 6-months commitment during these 6-months he/she will update the docs to the language chosen. I recommend to have only one language for a volunteer as it is almost impossible to do the amount of work in more languages.

What is already accomplished:

.1. I received information that there are already a couple of volunteers out there who are willing to translate the docs to Italian, German and Dutch?
.2. I already committed myself for the first year for the language Dutch!

How to proceed?

This is the part I am not sure about. I want to start seeking other volunteers through the chat and this issue but would like to know if this is a good idea and if it would benefit others.

Let me know what you think and reply!

http://docs.gantry.org/user/pages/01.gantry5/03.configure/04.layout-manager/offcanvas_4.png
needs to be updated after the following ticket has been fixed:

gantry/gantry5#187

Gantry installs itself to several directories in Joomla and therefore directory structure on https://github.com/gantry/gantry5 is different than that on a Joomla installation.
Can you update http://docs.gantry.org/gantry5/advanced/file-overrides in such a way so that we can know the equivalents of each other?

Chapter: 5. Advanced
Part: 1. Creating a New Particle
Section: Pulling Gantry Configuration Data Using Twig

Paragraph 3:

Pulling a configuration varialbe is pretty easy. You just need to use the gantry.config.get() command to pull this data.

The fourth word "varialbe" should be "variable".

http://docs.gantry.org/gantry5/advanced/customizing-theme-files

The yaml needs updating as there is now another option:

0: Fullwidth (Boxed Content)
2: Fullwidth (Flushed Content)
1: Boxed

It would be a lot easier to find/notice the Joomla | WordPress tabs if they were located at the top of each section, and perhaps given a color that stands out a bit more.

Alternatively, a big, bold platform selector at the top that automatically switches all the tabs on the page (and remembers the user's preferences for multiple pages/sessions) would be optimal.

Right now we have this in the Overriding Particle Settings

The first thing you will need to do is copy the copyright.html.twig and copyright.yaml files located in ROOT/media/gantry5/engines/nucleus/particles/ and paste the copies to TEMPLATE_DIR/custom/particles. If the particles directory does not already exist in your custom folder, you will have to create it.

We need a WP path to the copyright.html.twig and copyright.yaml files

We should add a dedicated page to nucleus' utilities where we list all of the ones that are available.
Things like visibile-phone, hidden-desktop you really need to go search for and are not written anywhere afaik.

ie, https://github.com/gantry/gantry5/blob/develop/engines/common/nucleus/scss/nucleus/_utilities.scss

Adding a Custom Style Sheet (pages/01.gantry5/04.tutorials/02.adding-a-custom-style-sheet/docs.md) needs to be updated to include the RC3 addition for auto recompilation triggered when a custom.scss files gets changed.

Same functionality described in the blog post, in fact, it could even be exactly the same.