We launched new forums in March 2019—join us there. In a hurry for help with your website? Get Help Now!
    • 28042 ☆ A M B ☆
    • 24,524 Posts
    I’ve adjusted the "help" page in the Manager to be a tabbed page where it’s easy to add tabs and use included files for each section for easier editing. This way I can have customized help for each client.

    I modified the manager/actions/help.static.php file:
    <?php
    if(IN_MANAGER_MODE!="true") die("<b>INCLUDE_ORDERING_ERROR</b><br /><br />Please use the MODx Content Manager instead of accessing this file directly.");
    ?>
    <script type="text/javascript" src="media/script/tabpane.js"></script>
    <br />
    <div class="sectionHeader"><img src="media/style/<?php echo $manager_theme; ?>/images/icons/b02.gif" alt="Help" style="vertical-align: text-bottom;" />  <?php echo $_lang['help']; ?></div>
    <div class="sectionBody">
        <div class="tab-pane" id="resourcesPane">
            <script type="text/javascript">
    		tpResources = new WebFXTabPane( document.getElementById( "resourcesPane" ) );
            </script>
            
            <div class="tab-page" id="tabDocsHelp">
                <h2 class="tab">Documents</h2>
                <script type="text/javascript">tpResources.addTabPage( document.getElementById( "tabDocsHelp" ) );</script>
                <?php include './help/docshelp.php'; ?>
            </div> 
            
            <div class="tab-page" id="tabUsersHelp">
                <h2 class="tab">Members</h2>
                <script type="text/javascript">tpResources.addTabPage( document.getElementById( "tabUsersHelp" ) );</script>
                <?php include './help/membershelp.php'; ?>
            </div>
    
            <div class="tab-page" id="tabLetterHelp">
                <h2 class="tab">Newsletter</h2>
                <script type="text/javascript">tpResources.addTabPage( document.getElementById( "tabLetterHelp" ) );</script>
                <?php include './help/newsletterhelp.php'; ?>
            </div>
                    
            <div class="tab-page" id="tabQEHelp">
                <h2 class="tab">Quick Edit</h2>
                <script type="text/javascript">tpResources.addTabPage( document.getElementById( "tabQEHelp" ) );</script>
                <?php include './help/quickedithelp.php'; ?>
            </div>
    
        </div>
    </div>
    

    and created a new folder, manager/help. I put the various help.php files there. It works out very nicely. One of the tabs can include the original help file content; links to the MODx site and various credits and attributions.

    Adding new tabs with new help pages is simply a matter of adding another tab block:
            <div class="tab-page" id="tabMODxHelp">
                <h2 class="tab">MODx</h2>
                <script type="text/javascript">tpResources.addTabPage( document.getElementById( "tabMODxHelp" ) );</script>
                <?php include './help/MODxhelp.php'; ?>
            </div>
    
      Studying MODX in the desert - http://sottwell.com
      Tips and Tricks from the MODX Forums and Slack Channels - http://modxcookbook.com
      Join the Slack Community - http://modx.org
      • 25663 MODX Staff
      • 12,272 Posts
      That’s really nice Susan. smiley
        Ryan Thrash, MODX Co-Founder
        Follow me on Twitter at @rthrash or catch my occasional unofficial thoughts at thrash.me
        • 25969
        • 118 Posts
        Nice, thanks for the tip. I will definitely use this in client projects.
          • 28042 ☆ A M B ☆
          • 24,524 Posts
          I’ve also added a Help link and icon to the main Welcome page, but that’s another story altogether.
            Studying MODX in the desert - http://sottwell.com
            Tips and Tricks from the MODX Forums and Slack Channels - http://modxcookbook.com
            Join the Slack Community - http://modx.org
            • 33337
            • 3,975 Posts
            very nice idea Susan smiley

            thanks for sharing.
              Zaigham R - MODX Professional | Skype | Email | Twitter

              Digging the interwebs for #MODX gems and bringing it to you. modx.link
              • 7231
              • 4,205 Posts
              This is cool, I was planning on adding the help as a PDF but to have it in the Manager as well rocks.

              I put the various help.php files there.

              Just curious, did you create this content custom or is it available someplace? I am in the process of putting together a help manual for my client and am suffering from writers block big time (it is so hard to work during the holidays, all I want to do is watch the Sponge Bob marathon shocked ). Anyway, I need to get this done so back to work.
                [font=Verdana]Shane Sponagle | [wiki] Snippet Call Anatomy | MODx Developer Blog | [nettuts] Working With a Content Management Framework: MODx

                Something is happening here, but you don&#39;t know what it is.
                Do you, Mr. Jones? - [bob dylan]
                • 28042 ☆ A M B ☆
                • 24,524 Posts
                The content is quite customized to this client’s specific needs. I have a section of simplified instructions for working with documents, working with the DADA mail module I made, and the CALx event calendar system. I’m hoping it will reduce the "how do I..." support requests. Considering that the latest such request was that they can’t log in to the manager anymore because their passwords don’t work since I’ve added a web login form to their site two days ago, I’m not too optimistic.
                  Studying MODX in the desert - http://sottwell.com
                  Tips and Tricks from the MODX Forums and Slack Channels - http://modxcookbook.com
                  Join the Slack Community - http://modx.org