700 pages

A couple of days ago, Johan asked how it was possible to write almost 700 pages on the Ribbon... I figured that this was probably as good an opportunity to tell what is in the book (RibbonX - Customizing the Office 2007 Ribbon) in my own words, as well as what we were trying to accomplish with it.  Due to the fact that we weren't really allowed to talk about it as we wrote, I didn't really get to blog much about my experiences.  So here goes...

First off, there is an index and a table of contents that add to the bulk a bit.  I'm going to blame that for a bit of the inflation.  😉

The book naturally starts off with an intro chapter that discusses what is needed to customize your UI in Office 2007, compared to the way we did it in previous versions.  It's sure not as easy as importing J-Walks' table driven menu code and filling out a short survey any more!  🙂

From there we got right to the content: A full chapter just on XML, how to read it, and how to build it.  Next we described the different methods for attaching a simple CustomUI to your project using both the unzipping/zipping method, (for Excel and Word files,) as well as the CustomUI editor.  We also discussed XML Notepad as well, as it is another tool that can be used to the developer's advantage.  Both these tools require the installation of the .NET 2.0 Framework on Windows XP, so that needed to be covered as well.

Once through the XML basics, we had to give the user the basics of VBA as well, since it's fundamental if you want to get more than just moving Microsoft's commands around.  So really, there was quite a lot before we even got into working with the Ribbon.

The meat of the book is broken down to cover all of the individual Ribbon elements, from the button to comboBox to dynamicMenu, and also has a dedicated chapter on using different attributes to format controls.  Every element is provided with complete (and legible) tables that detail what attributes it has, their default values (if any), acceptable parameters and callback signatures.  In many cases, images are even provided to demonstrate exactly how certain attributes display on screen.

It was really important to me that each chapter be something that you could refer back to when writing your code.  I wanted every user to be able to get the answer to this kind of scenario... "Why doesn't my dropDown work?  Oh!  It doesn't support the attribute that I put in!"

What really added to the page count, though, was that we chose to demonstrate by example as well.  There are full examples, rife with XML and VBA, of using each element.  In 90% of the cases, we included an example in each of Excel, Word & Access.  We walk the reader through the creation of the file, as well as hooking up the pieces of code to make things work.  We really made an attempt to teach the "how", rather than just give a "this is the theory, now good luck".  I can't even begin to count the hours that I spent coming up with examples, building them, testing them, and documenting them.  There were a lot that ended up on the cutting room floor, too, some of which ended up as "CAUTION" notes in the book.

After discussing all the basic controls, we felt that it would be really useful to give some examples of using attributes to provide help to your users.  User interface design and efficiency is a bit of a passion of mine, and after all, this entire book is about creating a good UI.  We felt that drawing the readers attention to some tricks to make life easier for the end user would be pages well written.

And then it was time to move into more advanced VBA, the Office menu, QAT and contextual tabs as well.  These chapters are packed with stuff that developers will find useful, my favourite of which is probably Robert's Table Driven QAT customization.

I'll say that the hardest chapter to write of the entire book was Chapter 16, which was on deployment, but I'm really happy with the outcome.  Being an Excel geek, the Excel part was simple, and I really enjoyed it.  Tony Jollans helped me a bit with the Word side of things, and the material there is much better for his doing so.  Both of the above cover using regular files, templates and add-ins/global templates.  In addition, we discuss sharing tabs across different files using the idQ attribute here, and have some pretty cool examples in Excel and Word of doing so.

There's much more in the deployment chapter as well, including a full subsection on deploying Access databases, written by Oliver Stohr.  While deployment of a full Access file to a user with a full Access install is a breeze, Oli covers how to do it using runtimes, locking down the UI where you don't want owners of the full version to tinker with your product, and much more.  He did some great work there to be sure.

The final chapter is on Security, and details how to set up the Trust Center for both you and your users.  It ends with a discussion of digital certificates, walking the user through creating and installing certificates created with SELFCERT.EXE.

And finally, the appendices included table after table of tags, from the names of tabs, groups and commands in each application, to imageMso and keytip information.  Our RibbonX naming conventions are also provided there, as well as an Appendix that details RibbonX resources on the web for anything we may not have covered.  Wiley is also hosting all of our example files on their site for download as well.  All of the examples we create will be there, as well as some additional files.

As you can see, we tried to make this book as full and complete as we possibly could.  I'll be honest in saying that I never thought we'd come close to this many pages at the outset, but once we started, the page count just seemed to keep mounting.  I'm fairly proud of the end result, and can honestly say that I was referring back to my own material constantly when trying to customize things at work.  My only regret about this book is that we couldn't have a CD included with the PDF version of the entire thing.  J-Walk has that for some of his, and its simply an awesome bonus.  I understand the concern, though, as it could be easily passed around, but for those legitimate buyers the ability to just put the PDF on your laptop, rather than carry the book around... it's a nice bonus.  Maybe next time.  🙂

I guess to summarize it all, there are a few factors that contribute to almost 700 pages... the fact that there are so many prerequisites to customization now, the HUGE amount of examples, and the large amount of reference tables and images that you'll find between the covers.  Overall, I really hope that people find this book a valuable resource for RibbonX customization.

The full table of contents is available on Wiley's site, if you'd like to know the breakdown of the chapter structure.  And, of course, you can pick it up at Amazon.com, among others.

Okay... enough about the book.  It's time to get back to other things.  😉

5 thoughts on “700 pages

  1. Sound great! As someone that worked alot with both XML and VBA it sounds like I can skip a few chapters then. 🙂

    Just the fact that you include a reference to all idMso and imageMso would make the book worth buying. It's not that easy to find out the id's of the built in commands. I know there are some Excel files to download, but still...

    Do you cover anything about using VSTO and/or VS.NET 2008 to customize the ribbons? Is ribbons in Outlook inspectors covered? I have like a zillion questions about ribbon customization, so maybe I just should go out and buy the book instead...... 🙂

    // Johan

  2. Hi Johan,

    The book doesn't actually cover VSTO or VS.NET in any flavour. As a matter of fact, I haven't even downloaded a copy of VS2008 yet.

    I can also say that what I've witnessed of those trying to deploy Outlook add-ins crafted in using VSTO SE, I'm kind of glad we didn't go there. Ultimately, I think to do Outlook justice you need someone who works with Outlook a great deal, and also knows their way around Visual Studio quite well. I'm not that individual. 😉

    Actually, that's brings to mind another thing worth mentioning... We kept this strictly focussed on the "classic" Office developer, without involving any other tools that boost the cost higher than the initial Office install.

  3. Ken,

    It is worth noting that VS2008 is using a very similar approach to our naming convention (in some cases, exactly the same). I think we were right to choose that approach. 🙂

  4. Pingback: Office 2007/2010 – Getting around the #$%^& Ribbon « SmittyPro

If you have a comment or question about the blog post content, please feel free to post it here. If you need help adapting this solution to your own needs, please post in our free help forum.

Your email address will not be published. Required fields are marked *