adrian

Module Settings Import / Export

Recommended Posts

Hi everyone,

This is the new official thread for the module that was previewed some time ago here: https://processwire.com/talk/topic/14117-module-settings-import-export/

Big thanks to @Robin S for help testing and feature suggestions!

http://modules.processwire.com/modules/module-settings-import-export/

https://github.com/adrianbj/ModuleSettingsImportExport

 

Module features

  • Ability to copy and paste settings from one PW install to another
  • Optional automatic backup of module settings on uninstall and ability to restore settings if you reinstall the module
  • Backup current settings at any time
  • Restore backed up settings at any time
  • Import option checks module name and version number and warns if importing settings from a different version

58b8ad9a23726_ScreenShot2017-03-02at3_40_38PM.thumb.png.717f4237132356614a01d62e58c1889f.png

As always, let me know if you find any problems or have any suggestions!

  • Like 19

Share this post


Link to post
Share on other sites

Hi @adrian, thanks for releasing this module.  I really like the concept.  I can see this being installed on every site.  I was able to copy over my TracyDebugger configs and AdminOnSteroids configs successfully.

It may be premature to ask, but is there a way to copy the configs of multiple modules at one time like you can do when you export your field settings?

  • Like 2

Share this post


Link to post
Share on other sites
2 minutes ago, gmclelland said:

Hi @adrian, thanks for releasing this module.  I really like the concept.  I can see this being installed on every site.  I was able to copy over my TracyDebugger configs and AdminOnSteroids configs successfully.

It may be premature to ask, but is there a way to copy the configs of multiple modules at one time like you can do when you export your field settings?

This is really the domain of 

although that module does still need a little attention.

That said, there might also be a place for it in this module - let me think on this a little more.

  • Like 1

Share this post


Link to post
Share on other sites

I was just reading about that module when you posted. :)

I just tried Module Toolkit...Wow what a time saver!  Thanks again adrian.

 

 

  • Like 1

Share this post


Link to post
Share on other sites

@adrian haven't you think about merging the two Module-related modules?

  • Like 1

Share this post


Link to post
Share on other sites
4 minutes ago, tpr said:

@adrian haven't you think about merging the two Module-related modules?

Yeah, I have and yesterday I decided not to because I didn't want to bloat this will all the tools available in Module Toolkit, but now I am second guessing that decision especially given that Module Toolkit is mostly a Process module so if you don't run it, it's not doing anything.

I'll think on this a little more - stay tuned :)

  • Like 1

Share this post


Link to post
Share on other sites

Some new features just added. Yes, these are starting to get into the functionality provided by ModuleToolkit, but I am still playing with the user interface and workflow trying to find the most efficient scenario. Along with the interface that is added to each module's settings page, this screencap shows the new interface available from this module's settings page. It shows a list of all stored module setting backups and adds a new interactive interface for selecting modules whose settings you want to copy to another site. As you check/uncheck modules, their settings will be added to the Settings textarea ready to copy to another site. If you paste in settings from another site and check "Update All", these settings will be imported into this site. You can choose to be warned of version mismatches, or force the import anyway.

Let me know what you guys think - am I on the right track with this, or is the ModuleToolkit approach better, or is there room for both? I still may combine the functionalities of both modules, or maybe even create a service that lets you manage your modules and their settings across multiple sites from once central dashboard.

modulesettinsimportexoport.thumb.gif.1e91eabbda1ba14359ec57bb7d2b6148.gif

  • Like 2

Share this post


Link to post
Share on other sites
3 minutes ago, adrian said:

 or maybe even create a service that lets you manage your modules and their settings across multiple sites from once central dashboard

I would be interested in this service.

  • Like 2

Share this post


Link to post
Share on other sites

I think the two modules should be merged, as they both serve module specific tasks.

  • Like 1

Share this post


Link to post
Share on other sites
On 5/9/2017 at 8:27 AM, jmartsch said:

I think the two modules should be merged, as they both serve module specific tasks.

I might do that sometime when I have more time.

On another note, I have just fixed the automatic backup of settings on module uninstall feature. Apparently it wasn't working properly :) Anyway, I think it's really useful so you know you can easily restore settings after an uninstall - very useful for some of the more complex modules out there.

  • Like 2

Share this post


Link to post
Share on other sites

Hi

Thanks for this nice module, you have created so far very useful modules, thank you again for all your contributions to Processwire.

One thing I noticed, this module does not work (modules not displayed) for modules who are not implementing the ConfigurableModule interfacce but are using the new module configuration described in here. https://processwire.com/blog/posts/new-module-configuration-options/

  • Like 1

Share this post


Link to post
Share on other sites
40 minutes ago, adrianromega said:

Hi

Thanks for this nice module, you have created so far very useful modules, thank you again for all your contributions to Processwire.

One thing I noticed, this module does not work (modules not displayed) for modules who are not implementing the ConfigurableModule interfacce but are using the new module configuration described in here. https://processwire.com/blog/posts/new-module-configuration-options/

Hi @adrianromega - thanks for the kind words and also for reporting this. Please test the latest version and let me know if that works ok for you. I also fixed a bug with the "Backed Up Settings" section on the config settings page for this module - where you can get the settings for all modules.

Share this post


Link to post
Share on other sites

Hi @adrian,

Could you please make a small change in ModuleSettingsImportExport.js to avoid an undefined variable error in PW 2.x? On line 11:

var allModuleSettings = typeof ProcessWire !== 'undefined' && ProcessWire.config ? ProcessWire.config.allModuleSettings : config.allModuleSettings;

I think this might be all that's needed for PW 2.x compatibility (although I haven't tested extensively).

Thanks.

  • Like 2

Share this post


Link to post
Share on other sites
44 minutes ago, Robin S said:

Hi @adrian,

Could you please make a small change in ModuleSettingsImportExport.js to avoid an undefined variable error in PW 2.x?

Thanks @Robin S - I have made that change along with some code cleanup and making all the module setting strings translatable.

  • Like 2

Share this post


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 Macrura
      Field Descriptions Extended
      This module enables you to extend field descriptions by dividing short descriptions with a longer text that is revealed in a toggle.
      Modules Directory: http://modules.processwire.com/modules/field-descriptions-extended/
      Github: https://github.com/outflux3/FieldDescriptionsExtended
      Extending your field descriptions using the standard field's description field.
      Once this module is installed, it will automatically search your description field for the presence of 5 dashes (-----).
      Any content above the 5 dashes will be visible and the content below the dashes will be hidden. A 'More...' link will appear at the end of the short description which when clicked will reveal the rest of the description.
      Using Simple Markdown Editor with the description field
      If you have Simple Markdown Editor (InputfieldSimpleMDE) installed, you can enable the field description to have that editor.
      *When using Simple MDE, you can use the button (Insert Horizontal Line) instead of typing 5 dashes. More about SimpleMDE.
      Extending your field descriptions using content from a ProcessWire Page for the field description.
      You may use the content from a ProcessWire page as a field description. This would allow you to easily insert images, links, and use hanna codes.
      To use page content for your field descriptions, please follow these instructions:
      Install Select Fields module (FieldtypeFields) http://modules.processwire.com/modules/fieldtype-fields/ Create a new field using this field type, e.g. field_select. Add the field to any template you will be using for your field descriptions. Setup your help pages (for example under a settings branch) where you will store the field description content,using the template containing the Field Select. Add content to a page and select the field where that content should show. To show a short text before the link to the longer content, separate them with 5 dashes Be sure to update your settings on this page, first enable page content descriptions,then specify the name of the Select Fields field, template to search, and content field. If you create a field description using this method, please note that the description field must be blank for contexts where you want the page content to appear.
      You can freely use template context for field descriptions, but the Page Content method is not context sensitive and will display under all contexts where the description is blank.
      ----
      original post:
      This is a new module, hope to release soon, which allows extended field descriptions, in currently 2 ways.
      The main feature of the module is that you can have a short description and then a 'more...' link which drops down a longer block of text.
      This is achieved by separating the intro/visible text and the rest with 5 dashes.

      Example setup:

      the 2nd way is if you are using AdminThemeUiKit, you can show extended field instructions in a panel. The content of the panel is edited on a regular PW page. This use case would probably not be that common, but if you had a field that required some extended instructions for how to use, this could be useful; Also, since this allows you to target information and instructions down at the field level, it could reduce the amount of documentation needed on a global level, since it is a lot more context targeted.

    • By Robin S
      Breadcrumb Dropdowns
      Adds dropdown menus of page edit links to the breadcrumbs in Page Edit.

      Installation
      Install the Breadcrumb Dropdowns module. The module requires ProcessWire >= v3.0.83 and AdminThemeUikit.
      There is a checkbox option in the module config that determines if the breadcrumb dropdowns will include pages that the user does not have permission to edit.
      Features/details
      The module adds an additional breadcrumb item at the end for the currently edited page. That's because I think it's more intuitive for the dropdown under each breadcrumb item to show the item's sibling pages rather than the item's child pages. In the dropdown menus the current page and the current page's parents are highlighted in a crimson colour to make it easier to quickly locate them in case you want to edit the next or previous sibling page. If the option to include uneditable pages is selected then those pages are indicated by a reduced text opacity and the "not-allowed" cursor is shown on hover. There is a limit of 25 sibling pages per dropdown for performance reasons and to avoid the dropdown becoming unwieldy. Incompatibilities
      This module replaces the AdminThemeUikit::renderBreadcrumbs method so will potentially be incompatible with other modules that hook the same method.
       
      https://modules.processwire.com/modules/breadcrumb-dropdowns/
      https://github.com/Toutouwai/BreadcrumbDropdowns
    • By joshuag
      Hey guys, 
      Thought I would share a quick preview of Designme. A module we (Eduardo @elabx and I) are building for visually laying out your templates/edit screens. 🙂
      This is a really quick, zero polish screen grab. FYI. 
      Video #2 - UPDATE
      This new video shows the following features in Designme:
      Re-arranging fields via Drag & Drop Re-sizing fields via Dragging. Adjusting field settings - with live refresh. Working on "hidden" fields while Designme is active. Creating New fields. Deleting fields. Creating/Deleting Tabs. Dragging fields between tabs. Creating fieldsets. Tagging/Un-tagging fields. Fields without headers expand when hovered (like checkboxes). Live filtering of fields in the sidebar. Ability to adjust (all) Template settings without leaving Designme. Template File Tree Editing Template files source code with ACE Editor. Editing Multiple files with ACE Editor. (New Tabs) Saving files. Techie stuff Fields load their own js/css dependancies. *ready to use on creation (*most fields)  Everything happens via Ajax to ProcessPageEdit (via module + hooks). Designme has a JS api that you can use.  All actions trigger events.  We would love any detailed feedback on what you see so far. If you are interested in testing Designme. Let me know below. 🙂
       
       
      Video #1. 
       
    • By dreerr
      TemplateEnginePug (formally TemplateEngineJade)
       
      This module adds Pug templates to the TemplateEngineFactory. It uses https://github.com/pug-php/pug to render templates.
      doctype html html(lang='en') head meta(http-equiv='content-type', content='text/html; charset=utf-8') title= $page->title link(rel='stylesheet', type='text/css', href=$config->urls->templates . 'styles/main.css') body include header.pug h1= $page->title if $page->editable() p: a(href=$page->editURL) Edit Project on GitHub: github.com/dreerr/TemplateEnginePug
      Project in modules directory: modules.processwire.com/modules/template-engine-pug/
       
      For common problems/features/questions about the Factory, use the TemplateEngineFactory thread.
       
    • By tpr
      ProcessNetteTester
      Run Nette Tester tests within ProcessWire admin.
      (continued from here)

      Features
      AJAX interface for running Nette Tester tests, in bulk or manually display counter, error message and execution time in a table run all tests at once or launch single tests show formatted test error messages and report PHP syntax errors stop on first failed test (optional) hide passed tests (optional) display failed/total instead passed/total (optional) re-run failed tests only (optional) auto scroll (optional) include or exclude tests based on query parameters start/stop all tests with the spacebar reset one test or all tests (ctrl+click) https://modules.processwire.com/modules/process-nette-tester/
      https://github.com/rolandtoth/ProcessNetteTester