From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Iremonger, Bernard" <bernard.iremonger@intel.com>,
Thomas Monjalon <thomas.monjalon@6wind.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit
Date: Wed, 1 Apr 2015 16:36:35 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE2F01048@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <8CEF83825BEC744B83065625E567D7C204A0B91F@IRSMSX108.ger.corp.intel.com>
> -----Original Message-----
> From: Iremonger, Bernard
> Sent: Wednesday, April 1, 2015 10:19 AM
> To: Thomas Monjalon; Mcnamara, John
> Cc: Butler, Siobhan A; dev@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit
> >
> > 2015-03-31 11:34, Mcnamara, John:
> > > Any objection to an additional patch to move the figure captions
> > > below the figures in the docs?
> >
> > No objection.
> > We should use figure:: keyword instead of image:: to add a caption.
> >
> > > The caption above the figure was the format used in the initial
> > > docs, and it looks okay in the HTML output, but in the PDF output it
> > > tends to get merged into the preceding paragraph and isn't always on
> > > the same page as the figure.
> >
> > Yes, it's a bit strange.
> > Why moving it below will ensure to keep it in the same page?
> > I think figure:: keyword may solve it.
>
> Hi John,
>
> My preference would be to keep the caption above the figure.
> This was the way it was done in the original 1.7 MSword documents (the
> starting point for the conversion to rst files).
Hi Bernard,
I don't mind the caption above. I'm mainly concerned with it staying with the image.
To do this we need to use the figure:: keyword as Thomas suggested. However, there are some knock on effects from this.
* As far as I can see, we can't just replace with image:: with figure:: in the |image-name| substitution definitions since Sphinx or RST doesn't support it.
* This means that the |image-name| substitutions will have to change back to explicit .. figure:: declarations. Not a big deal.
* The captions have to be under the image. I don't see a way to configure it to be on top. It may be possible in LaTex but not in Html.
* We should also modify the table captions in the same way.
So at this point I'm sorry I brought it up. I can post a programmatically generated patch as an RFC if there is interest in seeing what the updated output would look like.
The main positive is that it would give us automatic* figure/table numbering in Html and PDF and the captioning looks quite good. (*This requires Sphinx 1.3).
John
next prev parent reply other threads:[~2015-04-01 16:36 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-31 23:35 [dpdk-dev] [RFC PATCH 0/4] welcome doc for new nics and environments Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 1/4] doc: fix file attributes Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 2/4] doc: move Xen guide out of programmers guide Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 3/4] doc: nics guide Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 4/4] doc: remove copyright footer Thomas Monjalon
[not found] ` <1678582.gq5SofjDC3@xps13>
[not found] ` <8CEF83825BEC744B83065625E567D7C2049DCD83@IRSMSX108.ger.corp.intel.com>
[not found] ` <1500004.RM7mZx5SlJ@xps13>
2015-02-02 17:54 ` [dpdk-dev] [RFC PATCH 3/4] doc: nics guide Iremonger, Bernard
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thomas Monjalon
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 1/3] doc: fix file attributes Thomas Monjalon
2015-03-19 18:03 ` Butler, Siobhan A
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 2/3] doc: move Xen guide out of programmers guide Thomas Monjalon
2015-03-19 18:03 ` Butler, Siobhan A
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 3/3] doc: nics guide Thomas Monjalon
2015-03-19 17:36 ` Iremonger, Bernard
2015-03-19 18:02 ` Butler, Siobhan A
2015-03-30 23:38 ` [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thomas Monjalon
2015-03-31 11:34 ` Mcnamara, John
2015-03-31 12:23 ` Thomas Monjalon
2015-04-01 9:19 ` Iremonger, Bernard
2015-04-01 16:36 ` Mcnamara, John [this message]
2015-04-01 17:20 ` Iremonger, Bernard
2015-04-02 7:59 ` Mcnamara, John
2015-04-02 11:04 ` [dpdk-dev] [RFC] doc: refactored figure numbers into references John McNamara
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=B27915DBBA3421428155699D51E4CFE2F01048@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=bernard.iremonger@intel.com \
--cc=dev@dpdk.org \
--cc=thomas.monjalon@6wind.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;
as well as URLs for NNTP newsgroup(s).