Project

General

Profile

Bug #10171

Usermanual

Added by Michel Leblond over 4 years ago. Updated over 4 years ago.

Status:
Fixed
Priority:
Medium
Category:
Usermanual
Start date:
10/21/2014
Due date:
% Done:

100%

Affected Version:
git development version
System:
Debian
bitness:
64-bit
hardware architecture:
amd64/x86

Description

I found some issue in numbering in the table of contents :

8.1 Lua usage
8.1 Lua API

See attached file.

darktableTableOfContent.png (67.7 KB) Michel Leblond, 10/21/2014 12:01 AM

History

#1 Updated by Ulrich Pegelow over 4 years ago

  • % Done changed from 0 to 10
  • Priority changed from Low to Medium
  • Assignee set to Jérémy Rosen
  • Status changed from New to Confirmed

Background is the violation of the docbook specifications in lua_api.xml, which gets auto-generated from the sources.

Instead of the docbook-conformant section definitions (<sect1>, <sect2>, <sect3>, <sect4>, and <sect5>) that part uses nested <section></section> environments. Those are valid xml structures but not valid docbook elements.

I know that fixing this will not be easy. The auto-generation code needs to keep track of the nesting level and construct the environment appropriate to the nesting level, which might require quite some changes but is doable. The maybe more problematic point: docbook allows only <sect5> as the deepest nesting level.

Assigned to boucman in the hope that this still can be fixed before 1.6.

#2 Updated by Jérémy Rosen over 4 years ago

  • Assignee changed from Jérémy Rosen to Ulrich Pegelow

section is a valid tag according to http://docbook.org/tdg/en/html/section.html but I might not be using it properly...

the problem with <sect*> is not counting the depth (It used to work, I probably have code for that flying around) the problem is that those tags are limited to a depth of 5 and an API will need deeper nesting than that...

I am not sure how to handle this... would moving the lua API to an annex section instead of the main documentation make sense ? I think it would be a good idea...

as for fixing for 1.6... the question is when do you want the usermanual string-frozen... I have no urgent stuff for 1.6 at this point so I can work on that, no problem...

(reassigning to you so you get a ping, but this is probably on my side to fix...)

#3 Updated by Ulrich Pegelow over 4 years ago

  • % Done changed from 10 to 50
  • Status changed from Confirmed to In Progress

Situation looks like the following: below <chapter> we can either use nested <section> or <sect1>,<sect2>,sect3>,...

But we cannot mix them. So the fastest solution is to continue using nested <section> in lua_api.xml and additionally switch to <section> in lua.xml.

I will take care and fix asap.

#4 Updated by Ulrich Pegelow over 4 years ago

  • Status changed from In Progress to Fixed
  • % Done changed from 50 to 100

#5 Updated by Jérémy Rosen over 4 years ago

awesome, thx a lot

#6 Updated by Michel Leblond over 4 years ago

No more problem ! Thank you very much !

Also available in: Atom PDF