in
Innovasys Logo

Auto generating links for Pascal-case words

Last post 09-18-2008 7:07 AM by Richard Sloggett (Innovasys). 1 replies.
Page 1 of 1 (2 items)
Sort Posts: Previous Next
  • 09-17-2008 9:29 AM

    • Shrike
    • Top 200 Contributor
    • Joined on 09-17-2008
    • Posts 1

    Auto generating links for Pascal-case words

    Hi.

    My company is using Doc-o-Matic (DoM) now for producing help. We're considering to change to DocumentX and HelpStudio pair. But we have come across some lack of features we've used to.

    The major of them is very nice feature DoM has got. When it generate help it takes each word in Pascal-case and tries to find a reference topic for it.

    For an instance. I write some topic wich contains configuration file (.config). In this config-file we have some elements with atributes contains full type names:

    <myCustomSection>
        <subsystem type="MyCompany.MyProduct.SuperSubsystem, MyCompany.MyProduct">..

     So, DoC can understand text 'MyCompany.MyProduct.SuperSubsystem' as a type name. And if I have reference documentation in the same help-project for this type, DoM create a link to it.

    Can HelpStudio do such thing? If not, consider it plz as a suggestion :)

  • 09-18-2008 7:07 AM In reply to

    Re: Auto generating links for CamelCase words

    This certainly sounds like an interesting idea. You can include similar kinds of links in Document! X content by surrounding with %..% - e.g. %MyNamespace.MyType%. My only worry about completely automatic conversion is that Document! X / HelpStudio would incorrectly create links where they weren't required - with the delimiter at least it's explicit that you want that to happen.

    Would you be able to drop me a line to richard@innovasys.com so we can explore this idea further - I can then log a specific change request here.

    Richard Sloggett
    Innovasys
    http://www.innovasys.com
Page 1 of 1 (2 items)