public inbox for linux-media@vger.kernel.org
 help / color / mirror / Atom feed
From: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: LMML <linux-media@vger.kernel.org>,
	Linux Doc <linux-doc@vger.kernel.org>
Subject: Re: [ANN] Media documentation converted to ReST markup language
Date: Thu, 14 Jul 2016 05:00:47 +0300	[thread overview]
Message-ID: <11676357.MV7iMPWTsY@avalon> (raw)
In-Reply-To: <20160713111143.20312bb9@recife.lan>

Hi Mauro,

On Wednesday 13 Jul 2016 11:11:43 Mauro Carvalho Chehab wrote:
> Em Sat, 09 Jul 2016 20:10:21 +0300 Laurent Pinchart escreveu:
> > The other one is related, the table of contents in the main page of each
> > section
> > (https://mchehab.fedorapeople.org/media_API_book/linux_tv/media/v4l/v4l2.h
> > tml for instance) only shows the first level entries. We have a full table
> > of contents now, and that's very practical to quickly search for the
> > information we need without requiring many clicks (or actually any click
> > at all). How can we keep that feature ?
> 
> It is not hard to change the level of entries, although I really hated the
> DocBook template that creates multi-depth TOCs everywhere, as it is very
> messy to see those big indexes in the middle of the book.
> 
> What I did was to add *one* full contents index (actually, up to level 5)
> at the first page of the book:
> 	https://linuxtv.org/downloads/v4l-dvb-apis-new/media/media_uapi.html
> 
> and kept the other ones with depth 1.

Thank you, that's exactly what I had in mind.

> > By the way, the "Video for Linux API" section (and the other sibling
> > sections) are child nodes of the "Introduction" section. That feels quite
> > odd.
>
> This was fixed already.

-- 
Regards,

Laurent Pinchart


      reply	other threads:[~2016-07-14  2:00 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-07-08 13:34 [ANN] Media documentation converted to ReST markup language Mauro Carvalho Chehab
2016-07-08 13:45 ` Hans Verkuil
2016-07-08 15:31   ` Mauro Carvalho Chehab
2016-07-09 14:36   ` Mauro Carvalho Chehab
2016-07-09 17:10 ` Laurent Pinchart
2016-07-13 14:11   ` Mauro Carvalho Chehab
2016-07-14  2:00     ` Laurent Pinchart [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=11676357.MV7iMPWTsY@avalon \
    --to=laurent.pinchart@ideasonboard.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@s-opensource.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox