Extend-Help-System-for-Extensions

For simplicity's sake, you can add a prefix to the name of your .MD files e.g. MyExtension_Introduction.md.

The trouble is that ugly prefix then shows up in the Contents.

Implementation Suggestions:

If The filename of the *.md file contains more than one dot:
1. Strip Extension (".md")
2. Strip everything before the *last* dot
3. use remaining text for Help contents tree

If the text contains an underscore, replace it by a single space.
If the underscore is followed by a single capital character, replace it by *nothing*.
This allows for CamelCase names in contents

With all of this I can have an MD file like

finantic.IndiQ.DataBase.IndiQ_Introduction.md

which shows in the Help content just as "IndiQ Introduction"
(which introduces my upcoming IndiQ Extension).

Note: So we don't disrupt the entire parsing system in place for Help titles, there will be a slight modification of the above rules.

finantic.Indi#Q.DataBase.IndiQ_Introduction

Specify a # to defeat the built in camel-casing.

For example: IndiQ would resolve to: Indi Q
but Indi#Q would resolve to IndiQ

This does not work as expected.

In the Extension's code I need

CODE:
HelpFactory.InsertPage(@"Extensions\myCompany.myProduct\myCompany.myProduct.File#Name");

Despite the Release Notes/Change Log of Build 47 says it should be "File%Name" (which does not work)

With this code the Help contents is displayed as requested: "FileName"

... but the page is not found, no matter if I name it
* .\Help\myCompany.myProduct.File#Name.md
* .\Help\myCompany.myProduct.File%Name.md
* .\Help\myCompany.myProduct.FileName.md

How is this supposed to work?

I have this in C# code:

CODE:
HelpFactory.InsertPage(@"Extensions\myCompany.myProduct\myCompany.myProduct.Preferences");

And this file in WL's folder:

./Help/myCompany.myProduct.Preferences.md

The help system shows "Preferences" in the tree at the correct position, but it opens

./Help/Preferences.md

(The WL7 Preferences file)

You will also need to install a separate page for "Extensions\myCompany.myProduct".

I have such a page...
And Preferences worked in the previous Build.

Sorry, ultimately the page titles need to be unique. Instead of Preferences can you use "MyProduct Preferences?" Like we do in all of our extensions like MC-Lab and Neuro-Lab for example. This will keep a consistent style as well in the Help.

Also, by convention we've been putting Extension Preference pages in the "Preferences" Help node: