Re: V4L docs and docbook

[Keith Packard]

Hans Verkuil <hverkuil@xxxxxxxxx> writes:

> But good table handling is a prerequisite for us since we rely heavily on that.

I converted an asciidoc document that included some tables to sphinx via
docbook using pandoc; that seemed to generate workable results for me,
but my needs are pretty simple.

Asciidoc has more sophisticated table support, providing the ability to
align text within cells and paint different kinds of borders. Sphinx
provides for spanning rows and columns, and multi-line auto-wrapped cell
contents. The rst docs say there's an emacs mode that can help paint the
source format, but I haven't tried that yet.

In any case, here's some tables from the document I converted:

asciidoc via docbook:

http://altusmetrum.org/AltOS/doc/altusmetrum.html#_altus_metrum_hardware_specifications

sphinx:

http://keithp.com/~keithp/altusmetrum-sphinx/hardwarespecs.html#altus-metrum-hardware-specifications

While completely unconfigurable, rst tables do at least benefit from an
easier to read input syntax; asciidoc tables are about as readable in
source form as troff or latex...

asciidoc:

	.Altus Metrum Flight Computer Electronics
	[options="header"]
	|================================
	|Device | Barometer | Z-axis accel | GPS | 3D sensors | Storage | RF Output | Battery

	|TeleMetrum v1.0
	|MP3H6115 10km (33k')
	|MMA2202 50g
	|SkyTraq
	|-
	|1MB
	|10mW
	|3.7V

	|TeleMetrum v1.1
	|MP3H6115 10km (33k')
	|MMA2202 50g
	|SkyTraq
	|-
	|2MB
	|10mW
	|3.7V

	|TeleMetrum v1.2
	|MP3H6115 10km (33k')
	|ADXL78 70g
	|SkyTraq
	|-
	|2MB
	|10mW
	|3.7V

	|TeleMetrum v2.0
	|MS5607 30km (100k')
	|MMA6555 102g
	|uBlox Max-7Q
	|-
	|8MB
	|40mW
	|3.7V

	|TeleMini v1.0
	|MP3H6115 10km (33k')
	|-
	|-
	|-
	|5kB
	|10mW
	|3.7V

	|EasyMini v1.0
	|MS5607 30km (100k')
	|-
	|-
	|-
	|1MB
	|-
	|3.7-12V

	|TeleMega v1.0
	|MS5607 30km (100k')
	|MMA6555 102g
	|uBlox Max-7Q
	|MPU6000 HMC5883
	|8MB
	|40mW
	|3.7V

	|EasyMega v1.0
	|MS5607 30km (100k')
	|MMA6555 102g
	|-
	|MPU6000 HMC5883
	|8MB
	|-
	|3.7V

	|==============================

rst:

	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
	| Device    | Barometer | Z-axis    | GPS       | 3D        | Storage   | RF Output | Battery   |
	|           |           | accel     |           | sensors   |           |           |           |
	+===========+===========+===========+===========+===========+===========+===========+===========+
	| TeleMetru | MP3H6115  | MMA2202   | SkyTraq   | -         | 1MB       | 10mW      | 3.7V      |
	| m         | 10km      | 50g       |           |           |           |           |           |
	| v1.0      | (33k')    |           |           |           |           |           |           |
	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
	| TeleMetru | MP3H6115  | MMA2202   | SkyTraq   | -         | 2MB       | 10mW      | 3.7V      |
	| m         | 10km      | 50g       |           |           |           |           |           |
	| v1.1      | (33k')    |           |           |           |           |           |           |
	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
	| TeleMetru | MP3H6115  | ADXL78    | SkyTraq   | -         | 2MB       | 10mW      | 3.7V      |
	| m         | 10km      | 70g       |           |           |           |           |           |
	| v1.2      | (33k')    |           |           |           |           |           |           |
	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
	| TeleMetru | MS5607    | MMA6555   | uBlox     | -         | 8MB       | 40mW      | 3.7V      |
	| m         | 30km      | 102g      | Max-7Q    |           |           |           |           |
	| v2.0      | (100k')   |           |           |           |           |           |           |
	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
	| TeleMini  | MP3H6115  | -         | -         | -         | 5kB       | 10mW      | 3.7V      |
	| v1.0      | 10km      |           |           |           |           |           |           |
	|           | (33k')    |           |           |           |           |           |           |
	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
	| EasyMini  | MS5607    | -         | -         | -         | 1MB       | -         | 3.7-12V   |
	| v1.0      | 30km      |           |           |           |           |           |           |
	|           | (100k')   |           |           |           |           |           |           |
	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
	| TeleMega  | MS5607    | MMA6555   | uBlox     | MPU6000   | 8MB       | 40mW      | 3.7V      |
	| v1.0      | 30km      | 102g      | Max-7Q    | HMC5883   |           |           |           |
	|           | (100k')   |           |           |           |           |           |           |
	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+
	| EasyMega  | MS5607    | MMA6555   | -         | MPU6000   | 8MB       | -         | 3.7V      |
	| v1.0      | 30km      | 102g      |           | HMC5883   |           |           |           |
	|           | (100k')   |           |           |           |           |           |           |
	+-----------+-----------+-----------+-----------+-----------+-----------+-----------+-----------+


-- 
-keith

Attachment: signature.asc
Description: PGP signature