1. According to http://daringfireball.net/projects/markdown/ either 4 spaces or
a tab at the beginning of the line demarks code, etc. (or backticks, of course).
3. How are you categorizing each page into the TOC if you are getting rid of
the TOC? I assumed that would be via the metadata.
From: r...@robmensching.com
Date: Tue, 25 Jun 2013 23:16:05 -0700
To: wix-devs@lists.sourceforge.net
Subject: Re: [WiX-devs] Infrastructure Improvement: help build
1. Markdown uses for spaces to demark code snippets. Or you can wrap the code
with `backticks`. 2. The "title" metadata is basically required (some
dependencies snuck into the tools). If you don't specify a "layout" then no
layout will be applied to the document. After that, you can put whatever you
want in the metadata but it only matters if the "layout" uses it. In general,
don't add lots of metadata because these documents also have to work in the
website build which uses different layouts. That code shows up next... then I'm
done with all this for a while. Whew.
On Tue, Jun 25, 2013 at 11:50 AM, Blair Murri <os...@live.com> wrote:
You are proposing that for markdown we use four spaces instead of tab chars.
Just wanted to make sure that was the rule.
Without going through the sources of your new tool, do you have a quick
reference for the headers (such as title and layout in your example) that are
supported?
Blair
From: r...@robmensching.com
To: wix-devs@lists.sourceforge.net
Date: Thu, 20 Jun 2013 05:05:46 +0000
Subject: [WiX-devs] Infrastructure Improvement: help build
There have been a few infrastructure improvements in the last six months.
First, there was the move to git. Second, there is the new infrastructure for
using xUnit.net testing. Now, I’m cleaning up the help build system because the
web
manual hasn’t been updated since WiX v3.7 moved to MSBuild. Additionally,
writing documentation is beyond annoying since you have to write in perfect
XHTML.
I’ve been using DocPad (http://docpad.org/) a lot lately to build static sites
and have been really happy with the functionality there. I’m moving the WiX
toolset site (http://wixtoolset.org/) to DocPad
to make it much easier to update the site. To get the help manual to integrate
well with the rest of the site, the new help system borrows a lot of concepts
from DocPad. That’s a good thing as long as you like Markdown. <smile/>
New help content will look like this. Imagine a file:
“src\chm\documents\overview\example.html.md”:
---
title: Name in CHM table of contents or title of page on Web.
layout: default
---
# Example Topic H1
This is a paragraph of text that explains stuff.
## Second Header using H2
This is more paragraph text to introduce code example:
<Wix>
<!-- Indenting four spaces means you can just write code! --->
<Feature Title='No & escaping necessary!' />
That’s it. The same thing in current XHTML documentation is much longer and
much harder to read and XML code snippets are horrible to write.
Ultimately, my hope is that this further reduces the friction to writing and
updating documentation so people will just go in and do it. If nothing else,
the new system will get the web site content updated and it will work well
together.
Updating the current http://wix.sf.net/ site is a bunch of layered hacks.
I hope to have my pull request coming soon that shows how it’ll all work very
soon.
Questions, comments and feedback?
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:
Build for Windows Store.
http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
WiX-devs mailing list
WiX-devs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/wix-devs
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:
Build for Windows Store.
http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
WiX-devs mailing list
WiX-devs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/wix-devs
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:
Build for Windows Store.
http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
WiX-devs mailing list
WiX-devs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/wix-devs
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:
Build for Windows Store.
http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
WiX-devs mailing list
WiX-devs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/wix-devs
