Documentation on Marko Apfel

Github Project Wiki: separate page filename from page title

Mon, 26 Nov 2012 07:45:00 +0100

Starting Point

In a former version of a project wiki on Github was a separation between the page filename and page title. So we build up our Wiki in a manner, that some well defined prefixes in the filename describe the overall context of the particular page.

Converting Creole to HTML, PDF, DOCX, ..

Fri, 24 Aug 2012 13:14:00 +0200

Challenge

We documented a project on Github with the Wiki there. For most articles we used Creole as markup language. Now we have to deliver a lot of the content to our client in an usual format like PDF or DOCX.

StyleCop throws documentation warning SA1600 for private elements

Thu, 12 Nov 2009 06:24:00 +0100

if you see the following warnings in your code:

You have two choices:

deactivate the rule but this disables this rule for all documentations – also the wanted
tune the detail settings In the settings editor you see additional options if you select the “Documentation Rules” root node

Building a Help-TOC by hand

Fri, 25 Sep 2009 09:24:00 +0200

If you build a TOC for a CHM-help by hand it is important the for an entry the <object>-tag directly follows the <li>-tag.

So this format works:

<LI><OBJECT type="text/sitemap">

and this format lets show nothing:

Sandcastle Help File Builder: Content Editor opens without functionality

Thu, 16 Apr 2009 10:52:00 +0200

If the content editor of SHFB opens without any functionality then the configuration file is corrupt.

This is repairable through deleting the config-files under C:\Documents and Settings\[YOUR\_USER\_ID]\Local Settings\Application Data\Eric\_Woodruff\...

Sometimes an error occurred during opening content editor next time. In this case you must study the message. Often you have created a not XML-wellformed content file. Open your last used files with an other XML-editor and look for the place which is described in the message. After fixing the prob you must close SHFB, delete the config-file again and reopen your SHFB-project.

HTML Help Compiler Error HHC3004

Wed, 11 Mar 2009 11:28:00 +0100

Today i had an error by building my sandcastle documentation project.

After compiling during opening the output instead my chm-file in the help viewer the internet explorer pops up with an error message that the destination could not be found. So i took a look in the log of the compile process and there was some warnings of the following type listed: