From 89577c08b573b6e0d0474da70483aa7b8faea4b9 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Sun, 6 Sep 2009 10:48:52 -0300 Subject: dvb-spec: Start a DocBook XML 4.1.2 version of DVB API docs From: Mauro Carvalho Chehab This is an unfinished work. It is a port of DVB API verison 3 from LaTex into DocBook. Currently, only chapters 1 and 2 were converted. Still pending the conversion of the remaining chapters and a good style revision after the end of the conversion. Priority: normal Signed-off-by: Mauro Carvalho Chehab --- dvb-spec/sgml/README | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 dvb-spec/sgml/README (limited to 'dvb-spec/sgml/README') diff --git a/dvb-spec/sgml/README b/dvb-spec/sgml/README new file mode 100644 index 000000000..99dd5fef3 --- /dev/null +++ b/dvb-spec/sgml/README @@ -0,0 +1,13 @@ +This directory doesn't contain the official DVB API + +It contains an effort of porting it from LaTex to Docbook XML 4.1.2 + +It is still a work undergoing. Contributions are welcome. + +CURRENT STATUS: + +Chapters 1 and 2 were converted. The remaining chapters aren't yet. + +File dvbapi-complete.sgml is a temporary file generated by a tool that +automatically do the conversion. While it doesn't compile, it is a good +starting point for the conversion. -- cgit v1.2.3 From 8de1392b607bd886b0a083452b85ce7144ad372c Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Sun, 6 Sep 2009 22:25:36 -0300 Subject: dvb-spec/sgml: Finish conversion to DocBook XML 4.1.2 From: Mauro Carvalho Chehab With the conversion of both v4l2 and dvb-spec to the same DocBook version used in kernel, it is now possible to do some interesting things like adding the docs upstream and/or merge or share chapters between the two specs. Also, after promoting this version to official, just one set of text tools will be needed to generate both DVB and V4L2 specs. Yet, more work is needed to validate the conversion, improve the layout of the documents, provide cross references, etc. Signed-off-by: Mauro Carvalho Chehab --- dvb-spec/sgml/README | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) (limited to 'dvb-spec/sgml/README') diff --git a/dvb-spec/sgml/README b/dvb-spec/sgml/README index 99dd5fef3..6f62d3ae2 100644 --- a/dvb-spec/sgml/README +++ b/dvb-spec/sgml/README @@ -1,13 +1,11 @@ -This directory doesn't contain the official DVB API +This directory doesn't contain the official DVB API. -It contains an effort of porting it from LaTex to Docbook XML 4.1.2 +It contains a port from LaTex to Docbook XML 4.1.2 It is still a work undergoing. Contributions are welcome. CURRENT STATUS: -Chapters 1 and 2 were converted. The remaining chapters aren't yet. - -File dvbapi-complete.sgml is a temporary file generated by a tool that -automatically do the conversion. While it doesn't compile, it is a good -starting point for the conversion. +All chapters were converted. The resulting pdf and html are close to the +original LaTex book. Yet, it lacks some efforts to improve +the output layout and it lacks a topic index. -- cgit v1.2.3