gamebookformat/todo.org

* TODO [21/47] [44%]
- [X] Debug output
- [X] DOT output
- [X] LaTeX output
- [X] RTF output
- [X] HTML output
- [X] Split out template hanlding into separate class from output
- [X] Inject Output dependencies
- [X] Save section-number mapping and reuse automatically
- [X] Add support for custom document templates.
  Fixed names and/or command-line options.
- [X] Add section links in LaTeX output.
- [X] Prettier LaTeX output
  Look at how some existing gamebooks are formatted.
- [X] Parse wiki-style tags used to mark up sections
- [X] New text formatting style for section references
- [X] Inventory pick up items
- [X] Codewords set
- [X] Check if has inventory item
- [X] Check if has codeword
- [X] Remove item from inventory (forced by instructions)
- [X] Enable link if not having an item
- [X] Enable link if not having a codeword
- [X] Make sure dropped items can not be picked up again
- [ ] Make inventory and codewords generic
  They are the same, sort of, and it might be good to be able to
  add other similar entities as well, like skills or spells or whatever.
- [ ] Fix problem with map file from other book sometimes crashing formatter
- [ ] Keys from formatted book should be added to map file, not replace it
- [ ] More formatting possibilities in sections
  Look at existing gamebooks to get ideas.
- [ ] Book option to set max section number to use
- [ ] Book option to set pdf layout (page size and number of columns)
- [ ] Book option to set title
- [ ] Book option to set author
- [ ] Book option to set date
- [ ] Quote strings to not break formatting.
- [ ] Template for book introduction (including rules etc)
- [ ] Some way to insert character sheet in book introduction
- [ ] Some way to insert dice at bottom of pages for LaTeX
- [ ] Some way to insert optional random numbers table at end of book
- [ ] Possibility to make predictable random numbers and shuffling for testing
- [ ] Test generate examples and compare to expected output in all formats
- [ ] Unit tests (finally...)
- [ ] Inserting images
- [ ] Verify gamebook for debug and dot outputs
- [ ] Dummy sections (handle properly when verifying)
- [ ] Counters (life, money, whatever) create and set
- [ ] Counters increase/decrease
- [ ] Counters check
- [ ] Document Gamebook format
- [ ] HTML CSS
- [ ] Higher level text-language for Gamebooks
ff 2013-06-08 21:24:03 +03:00			`* TODO [21/47] [44%]`
Initial basic version of gamebook formatter. Reused old paragraphs.py and test_paragraphs.py. Implemented very basic output for Graphviz DOT and LaTeX files. Basic plain-text debug output. 2013-05-28 00:33:36 +03:00			`- [X] Debug output`
			`- [X] DOT output`
Todo list updated and in better format. 2013-05-28 00:40:21 +03:00			`- [X] LaTeX output`
Added simple HTML output support. 2013-05-29 01:01:17 +03:00			`- [X] RTF output`
			`- [X] HTML output`
Cleaned up output and templates handling a bit. 2013-06-03 23:19:06 +03:00			`- [X] Split out template hanlding into separate class from output`
			`- [X] Inject Output dependencies`
Export and import JSON mapping of section numbers. Except if flag -M is given. 2013-06-04 00:46:11 +03:00			`- [X] Save section-number mapping and reuse automatically`
Flag -t to add custom template dirs to override default templates. 2013-06-04 01:22:54 +03:00			`- [X] Add support for custom document templates.`
Todo list updated and in better format. 2013-05-28 00:40:21 +03:00			`Fixed names and/or command-line options.`
LaTeX with cross-references. Seems to work, but following links in PDF brings you to the top of the section below the heading, sometimes meaning that the number is not visible on screen. Also section headings could perhaps have better layout with less empty space above and below. 2013-06-04 01:57:45 +03:00			`- [X] Add section links in LaTeX output.`
Improved LaTeX references. Includes some ugly hacks like the empty sections to increase counter. 2013-06-04 23:32:03 +03:00			`- [X] Prettier LaTeX output`
			`Look at how some existing gamebooks are formatted.`
Codewords and items. Need to think more about design and code is not pretty. 2013-06-07 01:14:06 +03:00			`- [X] Parse wiki-style tags used to mark up sections`
			`- [X] New text formatting style for section references`
Can pick up items in HTML version. First stubs for HTML Javascript. Ugly hack warning. Too tired to design. 2013-06-07 22:41:52 +03:00			`- [X] Inventory pick up items`
Codewords set in HTML. Feel bad about how copy-pasted codewords are from items. Ideally the same code would handle both. Not now though. 2013-06-07 23:03:28 +03:00			`- [X] Codewords set`
Items and codewords. Gamebooks are now quite playable in HTML version. Planning to redesign inventory and codewords to be handled the same way, to allow adding other things that behave in a similar way to a gamebook (eg skills or spells). Also some obvious things are missing like being able to check if NOT having an item or codeword, or preventing a player from finding the same item twice (if redirected back to a section where it can be found after dropping it). 2013-06-08 00:18:33 +03:00			`- [X] Check if has inventory item`
			`- [X] Check if has codeword`
			`- [X] Remove item from inventory (forced by instructions)`
Allow player to follow a link if not carrying a specific item. 2013-06-08 21:13:30 +03:00			`- [X] Enable link if not having an item`
Allow player to follow a link if not having a specific codeword. 2013-06-08 21:18:05 +03:00			`- [X] Enable link if not having a codeword`
ff 2013-06-08 21:24:03 +03:00			`- [X] Make sure dropped items can not be picked up again`
Items and codewords. Gamebooks are now quite playable in HTML version. Planning to redesign inventory and codewords to be handled the same way, to allow adding other things that behave in a similar way to a gamebook (eg skills or spells). Also some obvious things are missing like being able to check if NOT having an item or codeword, or preventing a player from finding the same item twice (if redirected back to a section where it can be found after dropping it). 2013-06-08 00:18:33 +03:00			`- [ ] Make inventory and codewords generic`
			`They are the same, sort of, and it might be good to be able to`
			`add other similar entities as well, like skills or spells or whatever.`
Codewords and items. Need to think more about design and code is not pretty. 2013-06-07 01:14:06 +03:00			`- [ ] Fix problem with map file from other book sometimes crashing formatter`
			`- [ ] Keys from formatted book should be added to map file, not replace it`
Use term section instead of paragraph. Because it will become confusing later when there is support for sections split up in several paragraphs otherwise. 2013-06-03 22:57:55 +03:00			`- [ ] More formatting possibilities in sections`
Todo list updated and in better format. 2013-05-28 00:40:21 +03:00			`Look at existing gamebooks to get ideas.`
Examples structure. New examples. Verification stub. Tags parsing. 2013-06-04 23:36:09 +03:00			`- [ ] Book option to set max section number to use`
			`- [ ] Book option to set pdf layout (page size and number of columns)`
			`- [ ] Book option to set title`
			`- [ ] Book option to set author`
			`- [ ] Book option to set date`
Can pick up items in HTML version. First stubs for HTML Javascript. Ugly hack warning. Too tired to design. 2013-06-07 22:41:52 +03:00			`- [ ] Quote strings to not break formatting.`
Examples structure. New examples. Verification stub. Tags parsing. 2013-06-04 23:36:09 +03:00			`- [ ] Template for book introduction (including rules etc)`
			`- [ ] Some way to insert character sheet in book introduction`
			`- [ ] Some way to insert dice at bottom of pages for LaTeX`
			`- [ ] Some way to insert optional random numbers table at end of book`
			`- [ ] Possibility to make predictable random numbers and shuffling for testing`
			`- [ ] Test generate examples and compare to expected output in all formats`
			`- [ ] Unit tests (finally...)`
			`- [ ] Inserting images`
todo 2013-06-04 23:39:46 +03:00			`- [ ] Verify gamebook for debug and dot outputs`
			`- [ ] Dummy sections (handle properly when verifying)`
todo 2013-06-03 23:08:07 +03:00			`- [ ] Counters (life, money, whatever) create and set`
			`- [ ] Counters increase/decrease`
			`- [ ] Counters check`
			`- [ ] Document Gamebook format`
Can pick up items in HTML version. First stubs for HTML Javascript. Ugly hack warning. Too tired to design. 2013-06-07 22:41:52 +03:00			`- [ ] HTML CSS`
Todo list updated and in better format. 2013-05-28 00:40:21 +03:00			`- [ ] Higher level text-language for Gamebooks`