cellio: (Default)
[personal profile] cellio

Two of my recent tech-writing questions on Writing Stack Exchange currently have large bounties (from someone else). I'd really like answers to both of these, and if you're into that sort of thing and can answer in the next few days, you might be able to collect a bounty. I have some leads now on both, but not developed solutions.

Adding tags to documentation built in Flare? -- I want to be able to tag topics in our large doc set and have those tags show up on the individual pages, so that somebody could click on (say) "kerberos" and see all of the topics that we've tagged thus. Think of it like blog tags. I learned in a tweet this afternoon that Flare has something called "concept markers" that emit "see also" sections; that's on the right track, it sounds like, but I don't want see-also bloat so it'll need some modification.

How can I highlight changes in HTML output from Flare, based on branch diff? -- people can look at the source diff on BitBucket, but what I really want is for the built HTML to be marked where the diffs are somehow. It seems like there should be a way to take the git diffs, use them to locally modify the (XML) source to insert, I dunno, changebars or font color changes or something, and then do the build. So far I have a pointer to diff2html, which looks like it will produce an HTML report of the diffs separate from the built documentation.

Do any of my readers have relevant know-how?

Expand Cut Tags

No cut tags