§ 5 - About aa_macro

§ 5.1 - aa_macro Basics

aa_macrov3 is a text macro system. I wrote it specifically with applications like wtfm in mind. aa_macrov3 is what gives a Jedi his power. It's an energy field created by all living things. It surrounds us... no, wait. That's something else. However, aa_macrov3 does underlie the power of this documentation system. This fully operational documentation system.

§ 5.2 - aa_macro Documentation

In using wtfm, what you're going to need the most is the aa_macro User's Guide, and specifically those sections of the document that describe the built-ins, variables, and the styles. You don't need to concern yourself with the initial sections that describe how to deploy aa_macrov3 in an application to use ? Unknown Style "wftm" ?; I've already done that for you.

§ 5.3 - Markdown. On Clearance, Even.

You might have (eventually) noticed that the original version of aa_macro User's Guide was written using Markdown, as are many of the documents in the aa_macrov3 repo. Markdown is many things, many good things in fact, but one thing it is not, is powerful. And therein, my friends, lies the rub. Documentation-wise, I have many things to say, and many ways I want to say it, and Markdown just doesn't do what I need it to do. Not even GitHub's slightly enhanced version comes close. So. Here we are. aa_macrov3 and this documentation system put together all the power I wanted in one convenient place.

§ 5.4 - Grindstone, nose to.

So the thing is, in order to really get the most out of wtfm, you're going to have to dig into the aa_macro User's Guide. If you find the documentation lacking, I am quite willing to work on it; it's working well for me, but clearly, if I don't understand what I'm doing... well, you know. It doesn't mean it's written adequately for anyone else.

The same goes for ? Unknown Style "wftm" ?, of course. If there's anything you want clarified in the documentation, or something I missed discussing entirely, by all means let me know and I will make a sincere effort to address it.

Keyboard Navigation

---

, Previous Page . Next Page t TOC i Index