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'm finally getting started on a MODx Cookbook. This will consist of "recipes" on how to do all sorts of things, from how to create a new template to how to create a new, dedicated resource for a newly registered user.

    It will be developed as a website first, then a PDF, then a print version. Permission has been given to use MODx forum posts, and full credits will be given for both the question and the solution.

    If you don't want your username and/or URL (if available) credited, just let me know, along with any other thoughts, requests or reservations you may have about the use of any of your posts. I will PM you if/when I use any of your posts, both questioners and responders.

    For example, I may have something like this:
    Question:
    How do I do XYZ?
    posted on 12/09/13 by somebody (this will be a link to somebody's URL if available)
    
    Solution:
    Here's how to do it.
    posted on 12/09/13 by somebodyelse (again, URL if available)
    Here's another way to do it, or a correction or embellishment on above solution
    posted on 12/10/13 by somebodyelseagain (again, URL if available)
    

    Suggestions, requests, thoughts are all welcome. I want this to be a community-driven project. What do you want to see in a book like this? What format and structure would you find most useful?

    The beginnings will probably not be too interesting, it has to start with a theme and and outline for the contents.

    http://cookbook.sottwell.modxcloud.com
      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
      • 436 ☆ A M B ☆
      • 265 Posts
      Hi Susan, this sounds fantastic! Great to see more people writing books about MODX - do you aim to get this actually published into a Kindle book/physical book?

      For the questions/answers - are they permitted to be about MODX core only, or can they be about third-party plugins?

      What target audience do you envision this being for? The experienced MODX builds looking for great tips, or the new beginning?

      I noticed you used the lower case "x" in "MODx"; does that mean this is for MODx Evolution or for MODX Revolution?
        MODX Ambassador for Thailand. Managing Director at Monogon, a web design and development studio based in Bangkok, Thailand. - Follow me on Twitter.
        • 28042 ☆ A M B ☆
        • 24,524 Posts
        To answer the last (and easiest) question first, Revolution. I use MODx because I'm a stubborn old bi...er, lady dog and have trouble learning new tricks.

        First question, anything at all. Core, add-ons, custom snippets and other stuff. Anything and everything useful, helpful, or just interesting.

        Target audience - everybody. I'm doing it in sections, with each section working from easy/beginner stuff to complicated, advanced stuff. (yes, I know I'm using the word "stuff" a lot, but this is still all kind of fuzzy)

        At this point everything, even the sections, are subject to influence by everybody's input. Of course, the first thing to get nailed down will have to be the basic outline, so sooner rather than later I'll finalize the sections.

        Having a problem with pdoResources at the moment, once I get it sorted out the current tentative Sections will be visible on the site.
          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
          • 3749
          • 24,544 Posts
          Doing the book in HTML is wise if you're ever going to do a digital version and do the conversion yourself with Calibre or Sigil, though HTML -> PDF can be problematical. My book looks like complete crap when converted from HTML to PDF. It might be worth pulling the HTML into Word 2007, massaging it a little, and using Word's built-in PDF converter. The premiere HTML to PDF converter is Prince, but it's $3800!

          If you plan on doing other formats (e.g., Epub, Mobi, AZW etc.), it's worth figuring out the gotchas ahead of time to save many many hours (if not months) of re-doing things so they'll work in those formats.

          If you never use lists or tables, it will make life easier. wink I finally just converted all the tables in my book to text for the digital edition (after a month or so of trying to get them to work on all platforms) and I wrote a PHP converter to completely rewrite the lists.

          BTW, the go-to distribution spot for digital editions seems to be SmashWords, and they don't accept HTML, only Word .doc files (not even .docx). I think Kindle Direct Publishing wants .doc files as well, and iBooks wants .epub. It's a jungle. wink
            Did I help you? Buy me a beer
            Get my Book: MODX:The Official Guide
            MODX info for everyone: http://bobsguides.com/modx.html
            My MODX Extras
            Bob's Guides is now hosted at A2 MODX Hosting
            • 28042 ☆ A M B ☆
            • 24,524 Posts
            Well, it's early days for that yet. I intend to get the site up, working, looking good. Then I'll look into various conversion options. I would presume that a clean, simple template and good layout practices should minimize any problems.
              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
              • 33976 ☆ A M B ☆
              • 571 Posts
              Great initiative!

              If you are OK with Markdown writing, may i suggest you having a look at Leanpub (which seems to be fairly popular among tech writers) ?
              Furthermore, Markdown documents should be fairly easy to use with MODX.

              All in all, good luck in your trip ma'am wink
                • 28042 ☆ A M B ☆
                • 24,524 Posts
                I hadn't thought of that. I have an installable package of MarkItUp that can be configured to use Markdown. I'm not sure that I want to go that route, though, learning a new markup language at the same time I'm trying to organize the book might be a bit too much. There are several technologies I need to learn as I go already. I will certainly think about it, though, and see what other advice I get as things progress.
                  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
                  • 3749
                  • 24,544 Posts
                  Quote from: sottwell at Jan 10, 2014, 04:03 AM
                  Well, it's early days for that yet. I intend to get the site up, working, looking good. Then I'll look into various conversion options. I would presume that a clean, simple template and good layout practices should minimize any problems.

                  Maybe, but it might be worth checking by running a quick conversion to Epub in Calibre and viewing it in the Calibre reader before doing a lot of work that you might have to undo.
                    Did I help you? Buy me a beer
                    Get my Book: MODX:The Official Guide
                    MODX info for everyone: http://bobsguides.com/modx.html
                    My MODX Extras
                    Bob's Guides is now hosted at A2 MODX Hosting
                    • 28042 ☆ A M B ☆
                    • 24,524 Posts
                    Well, I checked the home page, and so far it's looking good.

                    I started out with the Skeleton responsive boilerplate, and haven't done much with it yet except to add one of the HTML-Kickstart menus at the top.

                    What was interesting about the calibre conversion is that the menu links were live!

                    I shall have to consider a way to make one huge page with links turned into anchor links. Hmm. Something like a sitemap, only with content of each page displayed. Interesting idea. I wonder how big it can get before calibre chokes on it.

                    http://www.mobileread.com/forums/archive/index.php/t-122466.html
                      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
                      • 3749
                      • 24,544 Posts
                      My book is 42,000+ lines of HTML code. Calibre does have a bug with very large files that strips tags that are inside pre tags toward the end. The text looks fine, but any bold, italic, or color highlighting is gone in the pre sections after that point. It's fine up to about 32,000 lines or so, though, so you're probably safe for a while. wink

                      I've reported the Calibre bug and expect that it will be fixed soon. Kovid is extremely responsive to bug reports.

                      Sigil will also do Epub conversions from HTML (though it's a little less convenient) and doesn't have this problem.

                      The PDF conversion of my book in Calibre looked pretty bad, but doing the PDF from Word 2007 looked great. YMMV.
                        Did I help you? Buy me a beer
                        Get my Book: MODX:The Official Guide
                        MODX info for everyone: http://bobsguides.com/modx.html
                        My MODX Extras
                        Bob's Guides is now hosted at A2 MODX Hosting