Jump to content
blad

Module: FirstSteps

Recommended Posts

This module displays tutorials according to the  page where you are (based on intro.js). It also displays useful links. It is in process. Suggestions and reviews are welcome. To test the module go to modules or pagelist after install.

screenshot1.png


screenshot2.png
 
screenshot3.png



Done:
- PageList
- Modules

To Do:
- Access
-User, Roles, Permissions
- Setup
-Templates
-Fields
-Languages
-PageEdit
-Search

 
 
Github

Edited by blad
  • Like 16

Share this post


Link to post
Share on other sites

hey blad,

 

looks great from what i see in the screenshot!

 

do you know nicos version? https://processwire.com/talk/topic/7666-getstarted-a-module-that-helps-first-time-users-to-understand-processwire-faster/

maybe you can also host one version of your module at lightning.pw for everyone to try?

I didn´t know that module :S I'll upload a video of 10 seconds. Thanks!

edited: or 40 seconds...

Edited by blad
  • Like 2

Share this post


Link to post
Share on other sites

thanks for the video - that's the most comfortable way to get a good impression :)

i like your module a lot and think it would be a great addition to the basic profiles!

  • Like 2

Share this post


Link to post
Share on other sites

I don't think developers need something like this (I would be annoyed at least), but it's a perfect solution for showing clients around! I would focus on that, making the module completely configurable so the developer can prepare a nice presentation of the interface once the site is finished. I would use it for sure :)

  • Like 6

Share this post


Link to post
Share on other sites

Agreed with Diogo, the idea of using this to help clients (and especially new users we haven't been able to instruct yet) to get used to the basic features of ProcessWire popped in my head instantly. Anyway, this looks awesome and I'll definitely give it a try soon! :)

  • Like 1

Share this post


Link to post
Share on other sites

Kudos, blad, this is impressive and has huge potential!

The irony of the proposal to tailor these modules to end users/editors is, that at least in my experience all of my customers praised the ProcessWire backend for its self-explaining quality. Other CMS need such a tool 1000 times more, but haven't. ProcessWire got two of them within a few days :D

  • Like 5

Share this post


Link to post
Share on other sites

I second everyone's comments - this looks awesome for showing clients around. Nico's module is definitely more for developers.

As diogo said - it would be awesome to have this configurable so that we could highlight features that are unique to each site and perhaps each template so if they go to edit a complicated page with lots of alternate options. I haven't thought through how you'd do this though - maybe an MarkupAdminDataTable where we could choose the template and create each slide of the tutorial for that template.

Anyway - awesome work - looking forward to seeing this progress!

  • Like 1

Share this post


Link to post
Share on other sites

It's nice even if it is kind of the same I build. 

I think your solution is nice for guiding around clients and mine is better for new developers who are using pw for the first time (I explain more about how it works and helpful links, etc.).

If you need help or want to reduce overlapping just contact me ;)

  • Like 2

Share this post


Link to post
Share on other sites

 

thanks for the video - that's the most comfortable way to get a good impression :)

 

i like your module a lot and think it would be a great addition to the basic profiles!

 

 

I don't think developers need something like this (I would be annoyed at least), but it's a perfect solution for showing clients around! I would focus on that, making the module completely configurable so the developer can prepare a nice presentation of the interface once the site is finished. I would use it for sure :)

 

 

Agreed with Diogo, the idea of using this to help clients (and especially new users we haven't been able to instruct yet) to get used to the basic features of ProcessWire popped in my head instantly. Anyway, this looks awesome and I'll definitely give it a try soon! :)

 

 

Blad you've done some fine piece of work :-). And agree here with both teppo & diogo.

 

 

Kudos, blad, this is impressive and has huge potential!

 

The irony of the proposal to tailor these modules to end users/editors is, that at least in my experience all of my customers praised the ProcessWire backend for its self-explaining quality. Other CMS need such a tool 1000 times more, but haven't. ProcessWire got two of them within a few days :D

 

 

I second everyone's comments - this looks awesome for showing clients around. Nico's module is definitely more for developers.

 

As diogo said - it would be awesome to have this configurable so that we could highlight features that are unique to each site and perhaps each template so if they go to edit a complicated page with lots of alternate options. I haven't thought through how you'd do this though - maybe an MarkupAdminDataTable where we could choose the template and create each slide of the tutorial for that template.

 

Anyway - awesome work - looking forward to seeing this progress!

 

 

It's nice even if it is kind of the same I build. 

 

I think your solution is nice for guiding around clients and mine is better for new developers who are using pw for the first time (I explain more about how it works and helpful links, etc.).

 

If you need help or want to reduce overlapping just contact me ;)

Thanks everyone! I´ll try to do this module a configurable site tour creator for our clients. I think a textarea with array and explode is the best solution. For example "PageProcess, #idor.class of element, Introtext" Can anyone help me with the "first steps"? :)

I tried to get the lines in a textarea with explode (\n & ,) and not working. I'm doing wrong something.

Share this post


Link to post
Share on other sites

It should work :-)...This is how I have done it in ProcessBlog

//$addTags will be a string of text separated by a new line (\n).
$addTags = $this->input->post->tags_add_text;

 if ($addTags) {
        $tags = explode("\n", $addTags);
        foreach ($tags as $t) {

             //do you stuff
       }

}

Good job on the module! :D

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

It should work :-)...This is how I have done it in ProcessBlog

//$addTags will be a string of text separated by a new line (\n).
$addTags = $this->input->post->tags_add_text;

 if ($addTags) {
        $tags = explode("\n", $addTags);
        foreach ($tags as $t) {

             //do you stuff
       }

}
Good job on the module! :D

Thanks Kongondo!!

Share this post


Link to post
Share on other sites

Hello everyone :)

It will be a pleasure working with you but give me 20 or 30 days. I work 15 hours a day and I can not now. I will return in a few days with a new video and fix my modules . 

  • Like 1

Share this post


Link to post
Share on other sites

(You just have to merge. It works great so far and I even updated intro.js and added a processbar and more). At the moment I'm adding all of my GetStarted texts to it (I have holidays so I have some time at the moment :) )

  • Like 3

Share this post


Link to post
Share on other sites

Done! Thanks Niko . I will return with an awesome video ... soon

  • Like 3

Share this post


Link to post
Share on other sites

Awesome! This is a great way to introduce new admin pages. Nice work.

  • Like 1

Share this post


Link to post
Share on other sites

This is really nice.

Is this module multilanguage?

How do we add translations?

I would help with german translations.

Share this post


Link to post
Share on other sites

Hey,

yes it is completely translatable. Just go to "setup -> languages" (you have to have multilanguage support activated) and chooses german or create german. There are two sections then: frontend and backend translations. Add a new backend translations and choose the modules file.

Share this post


Link to post
Share on other sites

I know there are mixed views on what should be core and what shouldn't, but I am thinking an option to install this during installation wouldn't be a terrible idea - you know, as long as the major pages are all covered with tutorials :) (And on that subject a few more things during install that could be optional too, but I digress).

This is useful for everyone but definitely new PW users (admins) to get an idea of what things do.

  • Like 1

Share this post


Link to post
Share on other sites

I think most of the major pages should be covered by now.

I'm not 100% happy the way it looks in the multilanguage translate thing because of the html tags used in the strings but I'm not sure how to solve that better...

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 jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

       
      Methods:
      replacementsTable()
      Renders an overview of all available replacements (see the example in the Module's config file:
       
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
       
      Download:
      https://gitlab.com/baumrock/RockReplacer
    • By bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
×
×
  • Create New...