Jump to content

Recommended Posts

Update: Menu Builder 0.2.2

As of today and this version onward, ONLY ProcessWire 3.x is supported.

Changelog

  1. Support for namespaced ProcessWire only (ProcessWire 3.x).
  2. Various bug fixes to getMenuItems(), breadcrumbs and saving menus in multi lingual environments (thanks for all reports in GitHub and the forums).

Available now in the modules directory.

Please note that this version does not address any PHP 7.x issues.

Screen: Menu Builder in UiKit

mb-version-22-pw3-only-uikit-screen.thumb.png.b4e96d1003b0e4a0a7ccfe1d41073c8a.png

  • Like 1
Link to post
Share on other sites
On 06/10/2017 at 10:16 AM, Zeka said:

Hi @kongondo

I have this setup: 

  • MenuItem1
    • Submenuitem_01( allowed children)
    • SubmenuItem_02 ( allowed children)
  • MenuItem2
    • Submenuitem_03 ( allowed children)
    • SubmenuItem_02 ( allowed children)

I'm using getMenuItems for building my menu, but the issue is that I get children of Submenuitem_02 as children only of the last Submenuitem_02 ( parent_id  =  id of the last Submenuitem_02 ), but I expected that I will get duplications of children pages with right parent_id for every Submenuitem_02

Of course, I can get children in my custom function but I think that in this case, getMenuItems doesn't work as expected and could be improved.

What do you think about it? 

Thanks, Eugene. 

Hi Eugene,

This is now sorted in version 022. Thanks.

  • Like 1
Link to post
Share on other sites
  • 1 month later...

Hi @kongondo

my client (using a multi-language site) just created a page, that is not relevant to anyone outside of Germany and therefore deactivated the english Version with ProcessWires default settings ("Active?"-checkbox behind the page url in settings) and it seems like inactive pages do not disappear in navigations built with MenuBuilder.

Is there a way to solve this, that I just didn't see or do I have to work around this?

Kind regards,
Thomas

Link to post
Share on other sites

@thmsnhl,

Just to clarify, are you saying you want the German version of the page to appear in the menu but not the English one? Meaning, if viewing the site in German, we see the page in the menu, if we view it in English, we don't. No, I've never considered such a scenario but now I see I should. If we are to skip that item from the menu, if it is a parent item, obviously, its children will also be skipped. 

Link to post
Share on other sites

@kongondo,

this is exactly what I would like to do.
And yes, if it is a parent page, the whole branch would be invisible but I guess this is self-explanatory and maybe even a wanted behaviour in most cases. If you don't want English users to see the parent, most likely you don't want them to see the children too.

Link to post
Share on other sites

@thmsnhl,

Could you please test the following for me before I commit? I have tested using both the normal way of generating menus (render()) and using the method getMenuItems(). I have also tested with include children and it works fine. As for include children, ProcessWire internally takes care of the inactive pages (I guess because it uses a find()), so I didn't have to touch that. 

In MarkupMenuBuilder.module, please add the following code after line # 216:

if(!$p->viewable($language)) continue;

Any issues?

Thanks.

Link to post
Share on other sites

There is another Problem with multi language, but I think this is more a general PW issue.

Steps to reproduce:

- Configure at least a second language in PW.

- As admin, work with the "other" language, not the default (Set in Admin->Profile).

- Create menus

- Switch back to default language (Set in Admin->Profile)

The titles are not set for the default language. (See screenshot).

It is the same problem when you create a field etc. in PW as a non standard language user.  The value for the default language is not being set.

mbbug.png.09f615b7f6d1affb9e1f993ac0a6b616.png

 

Link to post
Share on other sites

@theo,

I'll have a look. I'm not sure about the ProcessWire side of things but MB itself does check for languages when installed in a multi-language site. It doesn't activate other languages when creating a menu (which are hidden pages in admin). Hence, when saving the menu it only saves the menu title as $page->title = 'My Menu'. Since no language is specified nor is there input for other languages, the title is saved to the current language's title field. When you switch to another language, there is no menu title to display since none was saved in the first place.

By the way, this is the reason why in multi-language sites, menus cannot be rendered using their titles or names. You need to pass render() the menu ID or page.

Back to the missing titles issue, it's an issue I have previously considered. Back then, I came to the conclusion that it was not worth having menu items with multi-lingual titles since I couldn't think of a scenario to justify it. Your use case demonstrates  that I need to revisit the issue. 

I'll work on this for the next version. When creating and editing menus, there will be inputs for the different languages that are available (creating) and for enabled languages (when editing) [difference here being no need to edit the title of a menu title if that language is not enabled for that menu]. 

Above means I'll have to change the way menus are created. It has been suggested before that MB should lose the textarea for input of menu titles (one-per-line). I think I'll go with a simple table (like the one used when adding custom menu items) with columns for each available language or a ul list or div with tabs for each available language (i.e., mimic ProcessWire's language title field). To create additional menus simultaneously, one would only have to click on an 'add another menu link/icon'.

This will also resolve the issue of rendering menu items using their titles in multi-language sites. If a menu title or name is passed to render(), we will look for a menu by that title in the user's language.

Sorry for the long post! Some of these are notes-to-self to be honest :P

Edited by kongondo
typos
  • Like 1
Link to post
Share on other sites
  • 4 weeks later...

dear kongondo, help the beginner:

two languages on the site
connected module 0.2.3

                    $menu = $modules->get('MarkupMenuBuilder');
                    $options = array(
                        'has_children_class' => 'has_children',
                        'current_class' => 'current',
                        'menu_css_id' => 'nav_home',
                        'menu_css_class' => 'slimmenu',
                    );
                    echo $menu->render('menu', $options);


1 language - everything is fine, 2 language:

Error: Exception: No menu items found! Confirm that such a menu exists and that it has menu items. (in /var/www/***/site/modules/ProcessMenuBuilder/MarkupMenuBuilder.module line 1415)

<code>#0 /var/www/***/site/modules/ProcessMenuBuilder/MarkupMenuBuilder.module(105): ProcessWire\MarkupMenuBuilder-&gt;throwError()</code><br />
<code>#1 /var/www/***/site/templates/home.php(24): ProcessWire\MarkupMenuBuilder-&gt;render(&#039;menu&#039;, Array)</code><br />
<code>#2 /var/www/***/wire/core/TemplateFile.php(287): require(&#039;/var/www/...&#039;)</code><br />
<code>#3 /var/www/***/wire/core/Wire.php(380): ProcessWire\TemplateFile-&gt;___render()</code><br />
<code>#4 /var/www/***/wire/core/WireHooks.php(714): ProcessWire\Wire-&gt;_callMethod(&#039;___render&#039;, Array)</code><br />
<code>#5 /var/www/***/wire/core/Wire.php(442): ProcessWire\WireHooks-&gt;runHooks(Object(ProcessWire\TemplateFile), &#039;render&#039;, Ar</code></b><br /><br /><small>This error message was shown because: you are logged in as a Superuser. Error has been logged. </small></p>


What did I want to do?

Link to post
Share on other sites
23 minutes ago, duncan said:

What did I want to do?

It's all in the documentation here :). Please also read the last couple of post above yours.

Quote

Similar to render(), the first argument is not optional and can be a Page object, a title, name or id of a menu or an array of menu items returned from a menu's menu_items field. This means that you only have to retrieve a menu once and pass that to both render() and renderBreadcrumbs()Note that for multilingual environments, you cannot pass the method a title or a name; only the other three choices will work

Since your site uses various languages, you need to pass render() either the ID of your menu, its Page object or an array of menu items. As per the post above yours, this limitation will be resolved in an upcoming update.

  • Like 2
Link to post
Share on other sites
  • 2 weeks later...

Hello all. It is my first time playing with MB and I am thrilled how simple it was to attache two menus (header and footer) to my current project. Now my goal is to have the menus in multilanguage and that is where something is still missing on my end. Reading carefully the manuals, I switched the rendering to menu IDs (getting them from the URL of the menu edit link) and both menus work fine. Presently I switched the default language to be Bulgarian and second - English. The issue I am having is that if I browse the default website: domain.com it shows everything in Bulgarian (which is fine). However if I point to domain.com/en/ it still shows the menu in Bulgarian instead of switching the page titles to the english version.

My menu structure is quite simple and I only added the MB to have a better understanding of its functionality so here is the structure:

-- Home
-- About
-- Services
---- Service 1
---- Service 2
---- Service 3
-- Portfolio
-- News
-- Contact us

To call the menu I am using the following rendering code:

//Building the array of options
$options = array(

'wrapper_list_type' => 'ul',// ul, ol, nav, div, etc.
'list_type' => 'li',// li, a, span, etc.
'menu_css_id' => 'menu-top-menu',// a CSS ID for the menu
'menu_css_class' => 'menu-item',// a CSS Class for the menu
'submenu_css_class' => 'sub-menu',// CSS Class for sub-menus
'has_children_class' => 'menu-item-has-children',// CSS Class for any menu item that has children
'current_class' => 'current-menu-item',
);

// load the module
$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
// Render the menu by title
echo $menu->render(1029, $options); // calling menu by ID to allow it on multilanguage site

Is there anything I am missing here? In the MB admin if I switch the language I see the links properly changing (for english it changes the path to /en/... but the titles are kept the same...

 

MenuBuilder-MultiLanguage.png

Link to post
Share on other sites

@MilenKo

There are two routes how you can achieve ML menus with MB.

1. Create separate menu for every language and depending on user language pass different pages for menu render method.

2. Enable additional language for the menu ( Settings tab -> Other active languages for this menu) I think that it is what you are looking for.

  • Like 1
Link to post
Share on other sites
1 hour ago, MilenKo said:

Is there anything I am missing here? In the MB admin if I switch the language I see the links properly changing (for english it changes the path to /en/... but the titles are kept the same...

Alternatively, just use the 'default_title' option.

Quote

default_title: Controls whether to display Menu Builder saved menu item titles/labels versus displaying pages' actual/current titles. This is useful in scenarios where, for example, you need dynamic titles such as in a multilingual environment where you would want navigation labels to change depending on the current language. The default option is to display saved titles. To instead display actual titles, set option to 'default_title' => 1 in your options array.

Switch it to 1 and you are good to go (0 means show what has been saved in MB; 1 means show the actual ProcessWire page's title for that menu item).

Link to post
Share on other sites

Thank you @Zeka and @kongondo

It seems as it was my mistake of having enabled Other active languages of the menu after I have added the pages and for some reason the language got the same in both. After disabling the option and reenabling it, I got the tabs for Default and English language texts so it is all good now and switching properly.

So to say, it is all working fine for multilanguage site out of the box as far as the person has taken the following steps:

1. Figure out the options array and apply the proper styling to the menu.

2. While rendering the menu, do not call the menu by name but use ID as the simplest thing to do (grab the URL from the menu edit link - id=XXXX where xxxx is the ID. In the instructions it was saying to call the menu using: 

$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
echo $menu->render('XXXX', $options);

However thanks to the community and the knowledge sharing here, I figured out how to fix it using the following:

$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
echo $menu->render(XXXX, $options);

4. In order to enable multilanguage options, just go to Setup>Menu Builder. From there while creating or selecting an already created menu, click on the Settings tab and enable the languages you would like the menu to be translated to from the: Other languages for this menu option. Once this step is completted, every menu option would have separate tabs for every language selected.

5. Test the menu pointing to the website url in different languages, ex. /en/ , /ru/ , /de/ etc.

  • Like 2
Link to post
Share on other sites
  • 1 month later...

Hello,

does anybody know, if there is a possibility to only output a certain menu level or certain siblings in the menu?
Like the begin of a start-level?

 

F.e. start the output at level "sub":

- parent item 1

- parent item 2 (don't output this)

- - sub item 2.1 (only show / output this)

- parent item 3

 

Currently used version is V 0.1.3 with ProcessWire 2.7.2

Regards
Bacelo

Link to post
Share on other sites

Hi @Bacelo,

Achievable from version 0.1.5 using the getMenuItems() method  (see examples here) or from version 0.1.8 using the 'disable menu items' feature. Please note that support for ProcessWire 2.x ceased with version 0.2.2. In your case, you can upgrade Menu Builder up to version 0.2.1. and you'll be fine. If you can though, I'd advise to upgrade to ProcessWire 3.x.

  • Thanks 1
Link to post
Share on other sites
1 hour ago, Bacelo said:

where can I download Menu Builder V 0.2.1 ?

From the repo. Browse the repository commits and click on the commit shown in the screenshot below:

mb-github-021-version.thumb.png.f04aa8e2a88584b4435d6dc10657114a.png

That will take you to the page where you can clone/download that version.

Edited by kongondo
added link to repo
  • Thanks 1
Link to post
Share on other sites
  • 1 month later...
On 6/4/2018 at 9:55 PM, bud said:

Hello, could someone may help me?

1. The menu builder just works fine but I am wondering if there is a way to have options for autocollapsing parts of the menu pathes as you can do with the module markup simple navigation? It would help me because my navigation is pretty large and I should not view the whole navigation tree after a fresh installation of the module.

2. The menu option "custom" works great for custom links but I have found no way to "import" a whole path of the processwire tree into the menu builder as you can do with the option "page". What could I do instead of getting all the menu items in just one by one?

3. I also tried first to use the "custom" option of the module for importing a whole items path and then switch over to the "custom" options but it seems not to be possible. 

May someone could help?

 

Hi @bud,


Welcome to the forums

  1. There is no auto-collapse option. You would have to code that yourself, e.g. using JavaScript. Maybe using the getMenuItems() method is best in this case.
  2. I don't understand this question. Please elaborate and/or illustrate
  3. I don't understand this question either.

 

 

 

Link to post
Share on other sites

I'm still not sure I follow. Custom menu items are ones you create yourself and are external to your ProcessWire site. E.g. www.google.com, etc. I'm also not sure whether you are talking about the backend or frontend of Menu Builder.

20 hours ago, bud said:

do you have some code to share related to your default menu tree (which uses just your css) where the menu tree just opens the part of the tree which is active (for example: one parent and their children should be open and everything else closed 

There's tons out there. Please Google 'accordion menu' OR (CSS only accordion menu). Once you've found what you like, let us know here and we can help you implement it.

Link to post
Share on other sites

@bud,

You can already do all the things you've mentioned.

  1. You can add 1 or 2 or 3 or 1000 or whatever number menu items in one go.
  2. You can delete them before OR after adding them to the menu.
  3. You can reorder items after adding them to the menu (drag and drop).
  4. You can nest items after adding them to the menu (drag and drop)
  5. You can rename menu item and also change its link (custom items)

See this example...

mb_backend_basics.thumb.gif.1f81c6c66980ae661f3179c59a4f2ff6.gif

Maybe you mean copy and paste custom links rather than entering them one by one? I think with a little JavaScript magic, that can be done..

If I'm still not getting you, you'll have to make a screengrab/video to explain what you are after,  I'm afraid.

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      This is a simple module I made so a client could quickly grab a QR Code of the page's url in the admin.
      There's not much to it for now, but if need be you can output anything using a hook:
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $event->return = "Your custom text"; }) You can also output the QR code on your front-end by calling the field:
      echo $page->qr_code_field; The module uses the PHP library QR Code Generator by Kazuhiko Arase. When looking for a way to generate a QR Code in PW I came across @ryan's integration in his TFA module. I'm not very familiar with fieldtype/inputfield module development so I blindly followed @bernhard (great) tutorial and his BaseFieldtypeRuntime. At some point I'll take a deeper look to make a module on my own.
      Some ideas for improvements :
      add the ability to choose what to ouput : page's url / editUrl / file(s) / image(s) / ... allow to output multiple QR codes ?
    • By Chris Bennett
      https://github.com/chrisbennett-Bene/AdminThemeTweaker
      Inspired by @bernhard's excellent work on the new customisable LESS CSS getting rolled into the core soon, I thought I would offer up the module for beta testing, if it is of interest to anyone.

      It takes a different approach to admin styling, basically using the Cascade part of CSS to over-ride default UiKit values.
      Values are stored in ModuleConfig Module creates a separate AdminThemeTweaker Folder at root, so it can link to AdminThemeTweaker.php as CSS AdminThemeTweaker.php reads the module values, constructs the CSS variables then includes the CSS framework Can be switched on and off with a click. Uninstall removes everything, thanks to bernhard's wonderful remove dir & contents function.
      It won't touch your core. It won't care if stuff is upgraded. You won't need to compile anything and you don't need to touch CSS unless you want to.

      It won't do much at all apart from read some values from your module config, work out the right CSS variables to use (auto contrast based on selected backgrounds) and throw it on your screen.
      You can configure a lot of stuff, leave it as it comes (dark and curvy), change two main colors (background and content background) or delve deep to configure custom margins, height of mastheads, and all manner of silly stuff I never use.

      Have been developing it for somewhere around 2 years now. It has been (and will continue to be) constantly tweaked over that time, as I click on something and find something else to do.
      That said, it is pretty solid and has been in constant use as my sole Admin styling option for all of those 2 years.

      If nothing else, it would be great if it can provide any assistance to @bernhard or other contributor's who may be looking to solve some of the quirkier UiKit behavior.
      Has (in my opinion) more robust and predictable handling of hidden Inputfields, data-colwidths and showIf wrappers.
      I am very keen to help out with that stuff in any way I can, though LESS (and any css frameworks/tools basically) are not my go.
      I love CSS variables and banging-rocks-together, no-dependency CSS you can write with notepad.



       

    • By opalepatrick
      I see old posts saying that repeaters are not the way to go in Custom Process Modules. If that is the case, when using forms (as I am trying to do) how would one tackle things like repeat contact fields where there can be multiple requirements for contact details with different parameters? (Like point of contact, director, etc) or even telephone numbers that have different uses?
      Just for background I am creating a process module that allows me to create types of financial applications in the admin area (no need to publish any of this, pure admin) that require a lot of personal or company information.
      Maybe I am thinking about this incorrectly?
    • By HMCB
      I ran across a reference to IftRunner module. The post was 6 years ago. I cant find it in available modules. Has it been pulled?
×
×
  • Create New...