Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>You really want to be looking into using the <a href="http://www.codeplex.com/Sandcastle" rel="nofollow noreferrer">Microsoft Sandcastle</a> documentation generator nowadays. It is perfectly capable of generating HTML Help v1.0/1.1 files (CHM) or v2.0 (for integration into Visual Studio Help). The actual .NET Framework development team used it (or a variant of it) to create the API documentation for the BCL, so you should have an idea of what it is capable of. I'm not sure on the exact nature of your intended documentation of course, but Sandcastle can be used <em>both for generating API documentation</em> and accompanying help pages (guides, tutorials, examples, whitepapers, glossaries, etc.) using its custom MAML (XML-like) markup language, which is essentially what gets used in XML comments in code.</p> <p><a href="http://www.codeplex.com/Sandcastle" rel="nofollow noreferrer">Here</a> is a basic guide to getting started with Sandcastle, but I suspect you'll just need to play around with it for a bit to understand it. The learning curve isn't particularly steep either, unless you insist on learning it from the command line. The easiest option by far is to use the <a href="http://shfb.codeplex.com/" rel="nofollow noreferrer">Sandcastle Help File Builder GUI</a>, which is superb tool and does not restrict you at all.</p> <p>Another useful resource is <a href="http://thoughtpad.net/alan-dean/cs-xml-documentation.html#seealso" rel="nofollow noreferrer">this C# XML Documentation guide</a>, which shows you how to properly document your API with XML comments that can get converted into CHM documentation and also IntelliSense.</p>
    singulars
    1. This table or related slice is empty.
    1. POmaking a help file for my application
      singulars
      1. PTQuestion
    1. PTAnswer
    1. USNoldorin
    1. USNoldorin
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    1. COSandcastle is great for generating API help. But not much for context sensitive help within an application.
      singulars
      1. PO
      1. USMehrdad Afshari
    2. CO@Mehrdad: Actually, it does a good job at both API and custom textual documentation. I've used it a fair amount in my experience, and found it easy to do either.
      singulars
      1. PO
      1. USNoldorin
    3. CO@Noldorin: I agree it's a powerful tool but it provides so much unneeded power sometimes. Specifically, there are cases in which the application documentation is essentially a set of raw HTML files which you want to bind together. I prefer command line hh.exe in that case.
      singulars
      1. PO
      1. USMehrdad Afshari
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload