Commit Graph

355 Commits

Author SHA1 Message Date
Daniel James
9f0429368d Bump quickbook version for beta.
A bit anal. But there you go.

[SVN r85826]
2013-09-22 10:49:01 +00:00
Daniel James
ba9e2ed772 Encode the filename macro.
Also tweak the utils string functions.

[SVN r85807]
2013-09-20 19:52:38 +00:00
Daniel James
ff2eec0518 A little more about upgrading to 1.6
[SVN r85599]
2013-09-08 07:47:06 +00:00
Daniel James
732600aaa5 Starting to document xsl parameters.
[SVN r85598]
2013-09-08 07:46:42 +00:00
Daniel James
867c11c8b3 Tweak the documentation structure.
[SVN r85597]
2013-09-08 07:46:16 +00:00
Daniel James
937cf87f61 Example of building documentation outside of the boost tree.
[SVN r85596]
2013-09-08 07:45:47 +00:00
Daniel James
3f0ad9cd77 Respect indentation at the start of a file.
Fix bug where a code block at the start of a file was not recognised.
I was actually adding this test to check that the `source_mode_unset`
mechanism in `doc_info_grammar.cpp` was working, but it ended exposing
this bug.

[SVN r85590]
2013-09-07 07:24:47 +00:00
Daniel James
c790319efe First example of building documentation with boost build.
[SVN r85470]
2013-08-25 19:10:31 +00:00
Daniel James
010bd25ba3 Start a more general intro to the documentation tools.
Mostly just the content from the wiki. I left out installing latex for now,
as it's a bit tricky, and rarely required.

[SVN r85468]
2013-08-25 19:09:41 +00:00
Daniel James
19119a5d02 Remove duplicate 1.6 notes.
[SVN r85435]
2013-08-23 13:46:21 +00:00
Daniel James
7676f00765 Fix standalone images in quickbook.
[SVN r85431]
2013-08-22 20:50:08 +00:00
Daniel James
99c2746329 Remove 'not ready' notes about block markup in lists.
The recent improvements to list generation have left me feeling more confident
about this.

[SVN r85430]
2013-08-22 20:49:50 +00:00
Daniel James
faca522959 A little copy editting for the 1.7 description.
[SVN r85429]
2013-08-22 20:49:31 +00:00
Daniel James
50c4cab88f Add a quick guide on upgrading to 1.6
[SVN r85428]
2013-08-22 20:49:05 +00:00
Daniel James
4fefa013a9 Add new elements in 1.6 to the main documentation.
[SVN r85407]
2013-08-20 08:57:49 +00:00
Daniel James
c58e64af03 Add note about xmlbase.
[SVN r85406]
2013-08-20 08:57:29 +00:00
Daniel James
0f37ec4da2 Add explicit ids to heading documentation.
[SVN r85405]
2013-08-20 08:57:13 +00:00
Daniel James
1adc92593c Update version meta-data documentation.
[SVN r85404]
2013-08-20 08:56:56 +00:00
Daniel James
09005dc2b4 Update the import and include documentation.
This is a bit incoherent at the moment. It needs to be rearranged so
that there's a tutorial that introduces the concepts in a more logical
order. But I want to press on with some of the other updates.

[SVN r85403]
2013-08-20 08:56:39 +00:00
Daniel James
6c412da094 Fix inaccurate heading id generation documentation.
All headings have ids generated, not just `h1`, `h2` and `h3`.

[SVN r85402]
2013-08-20 08:56:24 +00:00
Daniel James
3db7767853 Start to document quickbook 1.6 include.
[SVN r85382]
2013-08-17 19:01:46 +00:00
Daniel James
d1d87511a9 Quickbook 1.6 alpha 1.
[SVN r85381]
2013-08-17 19:01:27 +00:00
Daniel James
6f06a8d7a6 Remove incorrect note about document id.
The document id has never been generated from the filename. It comes
from the docinfo `id` attribute, or if that doesn't exist, it's
generated from the document title. Although, thanks to bugs, it's a bit
more complicated than that.

[SVN r85328]
2013-08-12 21:42:20 +00:00
Daniel James
55d7447469 Fix single entity source mode notes.
[SVN r85327]
2013-08-12 21:42:01 +00:00
Daniel James
29ee34d4b7 Split up the language version chapter.
[SVN r85288]
2013-08-10 19:18:25 +00:00
Daniel James
c784dcbc44 Some notes about recent quickbook changes.
[SVN r85287]
2013-08-10 19:17:51 +00:00
Daniel James
8dfd18abd4 Expand all phrase templates inline, even if they contain blocks.
Hopefully more intuitive than turning what looks like a phrase into
a block.

[SVN r85130]
2013-07-23 08:23:29 +00:00
Daniel James
57e59f148a Allow block markup in phrase templates.
[SVN r85127]
2013-07-23 08:22:26 +00:00
Daniel James
2b5f23951e Allow block markup inside nested blocks (e.g. tables)
Since this is often indented, does not treat indented blocks as code
blocks. This is inconsistent for lists, so maybe indented blocks in
lists should always be code, or never be code. Or maybe it should be a
bit smarter about nested indented blocks.

[SVN r85126]
2013-07-23 08:21:56 +00:00
Daniel James
705605b381 Error if phrase element body doesn't parse.
[SVN r85117]
2013-07-22 19:34:32 +00:00
Daniel James
7dcc517949 Error if element used in incorrect context.
Should be less suprising than just not processing them. Needs more tests.

[SVN r85116]
2013-07-22 19:34:03 +00:00
Daniel James
8e0047f0fb Don't break out of a list after a block tag.
[SVN r84936]
2013-07-01 19:35:37 +00:00
Daniel James
774fe19d0b Check for errors when writing dependencies.
[SVN r84933]
2013-07-01 19:34:33 +00:00
Daniel James
0c69657973 Make nested paragraphs/code blocks in lists an error in 1.6.
They're now a 1.7 feature. Will revert to 1.5 behaviour before 1.6 final.

[SVN r84932]
2013-07-01 19:34:07 +00:00
Daniel James
671747969e Fix 'doc info macros' id.
[SVN r84637]
2013-06-04 18:57:02 +00:00
Daniel James
919e42eafb Better project names.
[SVN r84564]
2013-05-30 21:47:02 +00:00
Daniel James
ac0f8cf92f Fix block example again. Refs #8545.
[SVN r84175]
2013-05-06 20:22:16 +00:00
Daniel James
172ff0f4e3 Macros in docinfo blocks for 1.6. Refs #8543.
[SVN r84153]
2013-05-05 13:47:26 +00:00
Daniel James
7e76b65ed8 C++11 keywords. Refs #8541.
[SVN r84152]
2013-05-05 13:46:57 +00:00
Daniel James
852820778d Only recognise preprocessor statements at the start of the line. Refs #8511.
[SVN r84151]
2013-05-05 13:46:38 +00:00
Daniel James
228e4a3add Make escaping dependent file names optional.
[SVN r84146]
2013-05-05 13:44:59 +00:00
Daniel James
e926e24bb7 Support the token pasting operator in C++ code blocks. Refs #8510.
[SVN r84063]
2013-04-28 11:16:11 +00:00
Daniel James
e15daf76b8 Fix the block example.
[SVN r84062]
2013-04-28 10:46:41 +00:00
Daniel James
31580d55a1 Better argument parsing.
[SVN r83134]
2013-02-24 16:18:39 +00:00
Daniel James
7b6525c19b Changelog note for quickbook 1.5.9
[SVN r83130]
2013-02-24 13:50:03 +00:00
Daniel James
7d11b6e8ed Quickbook: Fix typo.
[SVN r83018]
2013-02-19 19:15:53 +00:00
Daniel James
7e7be11fae Quickbook: Describe new 1.6 tags.
[SVN r82589]
2013-01-23 00:06:27 +00:00
Daniel James
f28e093ce6 Quickbook: Backdated changelog for 1.5.8.
Oops, I completely forgot to write this up at the time.

[SVN r82573]
2013-01-20 23:50:25 +00:00
Daniel James
cd7cac186c Quickbook: Fix documentation.
Was using a feature I haven't implemented yet.

[SVN r78728]
2012-05-28 17:58:37 +00:00
Daniel James
6d2840baff Quickbook: Remove glob support for now. It isn't ready for release.
[SVN r77383]
2012-03-18 19:50:18 +00:00
Daniel James
6c54bc38c4 Quickbook: Merge quickbook-dev into trunk.
[SVN r77382]
2012-03-18 19:39:00 +00:00
Daniel James
0463a93263 Quickbook: Merge from trunk.
Includes blocks in lists fixes, and some documentation changes.


[SVN r77347]
2012-03-16 08:48:10 +00:00
Daniel James
fe883c5b76 Quickbook: Use anchors for linking to syntax.
Will make restructuring documentation easier.

[SVN r76972]
2012-02-11 12:34:10 +00:00
Daniel James
d525c56f60 Quickbook: Some explicit section ids.
[SVN r76971]
2012-02-11 12:33:46 +00:00
Daniel James
d9931935cd Quickbook: Changelog for 1.49
[SVN r76847]
2012-02-02 23:47:19 +00:00
Daniel James
a883a5b13c Quickbook: Initial implementation of templates in link values.
[SVN r76647]
2012-01-22 23:08:21 +00:00
Daniel James
0c0795fcff Quickbook: Escaped markup in docinfo blocks.
[SVN r76645]
2012-01-22 23:07:26 +00:00
Daniel James
aefb22bc28 Quickbook: Merge from trunk to quickbook-dev.
[SVN r76255]
2012-01-01 13:35:27 +00:00
Daniel James
821bc75c77 Quickbook: Fix escaping in some code examples.
[SVN r76254]
2012-01-01 12:37:00 +00:00
Daniel James
5892db6a0d Quickbook: Fix some errors in 1.7 docs.
[SVN r75898]
2011-12-11 11:28:59 +00:00
Daniel James
672caeec17 Quickbook: Code block callouts.
[SVN r75897]
2011-12-11 11:16:01 +00:00
Daniel James
3ed6415296 Quickbook: Support single entity source mode marker.
[SVN r75895]
2011-12-11 11:14:17 +00:00
Daniel James
13ce9e9fdb Quickbook: Use 1.7 for everything on dev branch.
Might promote them to 1.6 later.

[SVN r75892]
2011-12-11 11:11:50 +00:00
Daniel James
4c2ad1f909 Quickbook: Merge from trunk to quickbook-dev.
[SVN r75846]
2011-12-07 09:40:30 +00:00
Daniel James
0034e20457 Quickbook: Small documentation improvements.
- Use `heading` rather than `h3` in changelog.
- Improve code block documentation.
- Update line break info.
- I'm pretty sure quickbook isn't Turing complete.
- Not just C++ syntax highlight any more.

[SVN r75845]
2011-12-07 09:21:11 +00:00
Daniel James
7bbc23917c Quickbook: Use fewer escapes in documentation.
[SVN r75844]
2011-12-07 09:20:48 +00:00
Daniel James
8052d2936a Quickbook: Use default doc build settings to match main docs.
[SVN r75843]
2011-12-07 09:20:27 +00:00
Daniel James
e4b7df253d Quickbook: Add some of the old quickbook-dev docs.
- Link example.
- Extra Docinfo information.
- Quickbook 1.3 and 1.5

[SVN r75842]
2011-12-07 09:20:04 +00:00
Daniel James
bab85ee477 Quickbook: Split up the documentation.
Into a `part` containing `chapter`s in order to match the boostbook
documentation.

[SVN r75841]
2011-12-07 09:19:39 +00:00
Daniel James
b8fc2c7db7 Quickbook: Merge from trunk to quickbook-dev.
[SVN r75763]
2011-12-01 18:07:38 +00:00
Rene Rivera
bceab2ece7 Implement glob multi-file includes.
[SVN r75761]
2011-12-01 04:29:54 +00:00
Daniel James
fa2cc5f339 Quickbook: Small edits to 1.6 docs.
[SVN r75745]
2011-11-30 08:22:19 +00:00
Daniel James
cc34500587 Quickbook: Merge from trunk to quickbook-dev
[SVN r75739]
2011-11-30 01:35:25 +00:00
Daniel James
354f26e020 Quickbook: Fix code blocks in quickbook docs.
Under 1.6 indentation rules they were interpreted as paragraphs inside a list
item. An alternative fix would have been to increase the indentation so that it
was more than the previous list item's.


[SVN r75703]
2011-11-28 08:47:11 +00:00
Daniel James
ef6628f851 Quickbook: Merge from quickbook-dev to trunk.
[SVN r75696]
2011-11-27 21:34:56 +00:00
Daniel James
73f76e778e Quickbook: Allow block elements in lists.
[SVN r75632]
2011-11-22 23:50:48 +00:00
Daniel James
0081b73a34 Quickbook: 1.6 note.
[SVN r75533]
2011-11-17 21:05:33 +00:00
Daniel James
53be4f1e81 Quickbook: Add boost versions to old releases.
[SVN r75527]
2011-11-17 21:03:41 +00:00
Daniel James
9711cead8b Quickbook: Parse lists with paragraphs.
Quite a big change. I moved the list logic into the grammar so that it's
easier to tell how to parse different blocks. Also reworked some of the
block vs. phrase stuff - it's a lot cleaner now which helped implement
this.  It generates terrible markup at the moment, but at least the
parser is in place.

[SVN r75446]
2011-11-10 18:17:00 +00:00
Daniel James
5f5c526ea3 Quickbook: Better table titles.
[SVN r75445]
2011-11-10 18:16:37 +00:00
Daniel James
00f06ac438 Quickbook: Convert quickbook docs to 1.6
[SVN r75444]
2011-11-10 18:16:19 +00:00
Daniel James
952b3b6550 Quickbook: Support version info outside of document info blocks.
[SVN r75442]
2011-11-10 18:15:49 +00:00
Daniel James
fc7e9d0919 Quickbook: Start to document 1.6
[SVN r75363]
2011-11-06 22:23:48 +00:00
Daniel James
8bb70e9c3b Quickbook: Revert documentation to trunk.
[SVN r75362]
2011-11-06 22:23:29 +00:00
Daniel James
3afae60dd4 Quickbook: Fix old changelog entry.
[SVN r75340]
2011-11-06 09:33:55 +00:00
Daniel James
19e7038643 Quickbook: Add tip clarifying BoostBook, DocBook, need to know.
Merged from change by Beman.

[SVN r75228]
2011-11-01 19:01:27 +00:00
Daniel James
6be83be59f Quickbook: Add Windows 7 as supported platform
Merged from change by Beman.

[SVN r75227]
2011-11-01 19:01:09 +00:00
Daniel James
fc3102422a Quickbook: Change log for 1.48.
[SVN r75225]
2011-11-01 19:00:38 +00:00
Beman Dawes
4069b1d024 Add tip clarifying BoostBook, DocBook, need to know.
[SVN r74752]
2011-10-06 12:10:27 +00:00
Beman Dawes
22eb772d42 Add Windows 7 as supported platform
[SVN r74737]
2011-10-05 13:35:10 +00:00
Daniel James
4d19afef68 Quickbook: Change log for 1.48.
[SVN r74350]
2011-09-11 17:00:54 +00:00
Daniel James
9b1eed66f4 Quickbook: Merge from trunk to quickbook-dev.
[SVN r73239]
2011-07-19 07:35:49 +00:00
Daniel James
f81dc542d6 Quickbook: Avoid expanding __FILENAME__.
[SVN r72823]
2011-06-30 20:27:02 +00:00
Daniel James
09165188f1 Quickbook: merge from trunk to dev.
[SVN r72762]
2011-06-26 11:07:04 +00:00
Daniel James
c72d4029c0 Quickbook: xml encode escaped punctuation.
[SVN r72760]
2011-06-26 10:44:00 +00:00
Daniel James
bf1d753dba Merge tools directory from trunk.
[SVN r72698]
2011-06-20 19:19:56 +00:00
Daniel James
15ad3c2e14 Quickbook: Trying to write a gentler intro to quickbook.
[SVN r72081]
2011-05-22 15:36:07 +00:00
Daniel James
72a250506f Quickbook: fix incorrect apostrophe.
[SVN r72080]
2011-05-22 15:35:41 +00:00
Daniel James
19e0188456 Quickbook: separate structure from syntax.
The structure information will get more complex with differences
between 1.5 and 1.6, and full attribute documentation. The syntax
section could be expanded to be a more useful introduction and to link
to the various parts of the reference documentation.

[SVN r72079]
2011-05-22 15:35:09 +00:00
Daniel James
4e654322cb Quickbook: Change log entry for syntax highlighter changes.
[SVN r71601]
2011-04-29 11:02:55 +00:00