Guidebook

Guidebook

6M Downloads

[Suggestion] Restructure of <book> and <chapter> to allow easier and more natural book authoring

jazeved0 opened this issue ยท 4 comments

commented

Hi; I rewrote the first part of demobook.xml to include some additional features/restructuring I think would highly benefit the mod (everything is explained in inline comments):

(I would be more than willing to implement these; I just wanted to see what you thought @gigaherz )

  • Automatic pagination & <pagebreak> tag
  • Introduction section
  • <chapter>s & <section>s
  • automatic <table-of-contents> construction
  • <enumerate> and <itemize> tags along with <item> tags
  • <code> and <note> tags

Link to Gist

commented

Hello! I have Pretty much exactly what you describe for sections, and automatic pagination... "in progress" locally (my head isn't currently in a state in which I can focus on modding, but I started working on it some months ago... :P).

As for all your other ideas, they are great, and I'll take them into account, whenever I find the motivation to get back to modding...

Thanks!

commented

Is there any chance you could create an indev branch to put your local work so that others could contribute? I'd like to help implement the above features into the mod while you're taking a break from modding. Thanks!

commented

I would push the changes to master, but the pagination system is not really in a state that would be usable for contributions, and that is something that I want to finish myself "soon".

However, since I already did finish the first iteration of the "visual tree" in the previous release, it should be possible to implement things like item lists, with the current codebase in master, without them requiring major rewrites afterward (I know how annoying it is to contribute something to a project, get it merged, and then get every single line of code you wrote replaced by a different implementation that looks nothing like yours).

For reference and to avoid stepping on each others' toes, I also have a rudimentary condition system, which will be used alongside the automatic pagination, to exclude chapters/sections/paragraphs depending on the game state such as advancements, or gamestages (see #35).

P.S. Avoid implementing the "intro" tag for now, I'm not fully convinced that it is really necessary, and it would clash with my work on the pagination.

commented

I have just uploaded version 2.5 (alpha, due to how experimental it is), which contains many experimental features, including pagination and conditions. Feel free to test (it's under review and should be available soon), and tell me if you can find any issue in it!