From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 7DC116942 for ; Wed, 1 Apr 2015 18:36:39 +0200 (CEST) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga102.fm.intel.com with ESMTP; 01 Apr 2015 09:36:38 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.11,504,1422950400"; d="scan'208";a="689012418" Received: from irsmsx105.ger.corp.intel.com ([163.33.3.28]) by fmsmga001.fm.intel.com with ESMTP; 01 Apr 2015 09:36:37 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.129]) by irsmsx105.ger.corp.intel.com ([169.254.7.2]) with mapi id 14.03.0224.002; Wed, 1 Apr 2015 17:36:36 +0100 From: "Mcnamara, John" To: "Iremonger, Bernard" , Thomas Monjalon Thread-Topic: [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thread-Index: AQHQYmSq5K7uUOtkjEK5k+UtWe4j9Z01r6mAgADXLND///6SAIABbghggABfuSA= Date: Wed, 1 Apr 2015 16:36:35 +0000 Message-ID: References: <1422747307-13792-1-git-send-email-thomas.monjalon@6wind.com> <2548676.I0KaJlYG5K@xps13> <7323830.CD7zFSQOoV@xps13> <8CEF83825BEC744B83065625E567D7C204A0B91F@IRSMSX108.ger.corp.intel.com> In-Reply-To: <8CEF83825BEC744B83065625E567D7C204A0B91F@IRSMSX108.ger.corp.intel.com> Accept-Language: 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" 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 01 Apr 2015 16:36:40 -0000 > -----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. >=20 > Hi John, >=20 > 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 t= he 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 suppo= rt it. * This means that the |image-name| substitutions will have to change back t= o explicit .. figure:: declarations. Not a big deal. * The captions have to be under the image. I don't see a way to configure i= t 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 g= enerated patch as an RFC if there is interest in seeing what the updated ou= tput would look like. The main positive is that it would give us automatic* figure/table numberin= g in Html and PDF and the captioning looks quite good. (*This requires Sphi= nx 1.3). John