From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <bernard.iremonger@intel.com> Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id 3D58A683D for <dev@dpdk.org>; Wed, 1 Apr 2015 19:21:08 +0200 (CEST) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga101.fm.intel.com with ESMTP; 01 Apr 2015 10:20:27 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.11,504,1422950400"; d="scan'208";a="475538280" Received: from irsmsx104.ger.corp.intel.com ([163.33.3.159]) by FMSMGA003.fm.intel.com with ESMTP; 01 Apr 2015 10:20:27 -0700 Received: from irsmsx108.ger.corp.intel.com ([169.254.11.216]) by IRSMSX104.ger.corp.intel.com ([169.254.3.49]) with mapi id 14.03.0224.002; Wed, 1 Apr 2015 18:20:25 +0100 From: "Iremonger, Bernard" <bernard.iremonger@intel.com> To: "Mcnamara, John" <john.mcnamara@intel.com>, Thomas Monjalon <thomas.monjalon@6wind.com> Thread-Topic: [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thread-Index: AQHQYmSq5K7uUOtkjEK5k+UtWe4j9Z01r6mAgADXLND///6SAIABbghggABfuSCAACGDQA== Date: Wed, 1 Apr 2015 17:20:25 +0000 Message-ID: <8CEF83825BEC744B83065625E567D7C204A0BAB5@IRSMSX108.ger.corp.intel.com> References: <1422747307-13792-1-git-send-email-thomas.monjalon@6wind.com> <2548676.I0KaJlYG5K@xps13> <B27915DBBA3421428155699D51E4CFE2F001CD@IRSMSX103.ger.corp.intel.com> <7323830.CD7zFSQOoV@xps13> <8CEF83825BEC744B83065625E567D7C204A0B91F@IRSMSX108.ger.corp.intel.com> <B27915DBBA3421428155699D51E4CFE2F01048@IRSMSX103.ger.corp.intel.com> In-Reply-To: <B27915DBBA3421428155699D51E4CFE2F01048@IRSMSX103.ger.corp.intel.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Cc: "dev@dpdk.org" <dev@dpdk.org> Subject: Re: [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK <dev.dpdk.org> List-Unsubscribe: <http://dpdk.org/ml/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://dpdk.org/ml/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <http://dpdk.org/ml/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> X-List-Received-Date: Wed, 01 Apr 2015 17:21:08 -0000 > -----Original Message----- > From: Mcnamara, John > Sent: Wednesday, April 1, 2015 5:37 PM > To: Iremonger, Bernard; Thomas Monjalon > Cc: Butler, Siobhan A; dev@dpdk.org > Subject: RE: [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit >=20 > > -----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). >=20 > Hi Bernard, >=20 > I don't mind the caption above. I'm mainly concerned with it staying with= the image. >=20 > To do this we need to use the figure:: keyword as Thomas suggested. Howev= er, there are some knock > on effects from this. >=20 > * As far as I can see, we can't just replace with image:: with figure:: i= n 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. >=20 > 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. >=20 > The main positive is that it would give us automatic* figure/table number= ing in Html and PDF and the > captioning looks quite good. (*This requires Sphinx 1.3). >=20 > John >=20 Hi John, I am not sure why the captions have to be under the images. At present the captions are just a bold line of text before the image in th= e rst files for example, **Figure 17. Components of a DPDK KNI Application** This will probably affect the cross reference links as well or does the aut= omatic numbering work with the links as well. =20 Regards, Bernard