From d0b63435151f7e5357aa1d1126440ac7ab4601c7 Mon Sep 17 00:00:00 2001 From: John Evans Date: Wed, 21 Aug 2013 10:33:36 -0400 Subject: [PATCH] minor wording changes --- docs/source/detailed_installation.rst | 5 +++-- docs/source/how_do_i.rst | 10 +++++----- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/source/detailed_installation.rst b/docs/source/detailed_installation.rst index 126efaa..dab4c3f 100644 --- a/docs/source/detailed_installation.rst +++ b/docs/source/detailed_installation.rst @@ -137,13 +137,14 @@ In addition, you must install contextlib2 and Pillow via pip. :: Windows ------- -32-bit WinPython 2.7.5 seems to work with OpenJPEG 1.X, 2.0, and the -development version, but still requires contextlib2 and mock to be +32-bit WinPython 2.7.5 seemed to work with OpenJPEG 1.X, 2.0, and the +development version, but still required contextlib2 and mock to be installed via pip. WinPython 3.3.2, however, seems to have trouble with OpenJPEG 2.0, so I would suggest using the development version there (I'm unwilling to spend ANY more time trying to figure out what the problem is there). +At the moment I do not have access to a win32 machine, and 64-bit windows is completely untested. diff --git a/docs/source/how_do_i.rst b/docs/source/how_do_i.rst index 110ca81..cc0b227 100644 --- a/docs/source/how_do_i.rst +++ b/docs/source/how_do_i.rst @@ -55,8 +55,7 @@ Consider the following XML file `data.xml` : :: -The **append** method can add an XML box (only XML boxes are currently -allowed):: +The **append** method can add an XML box as shown below:: >>> import shutil >>> import glymur @@ -108,8 +107,8 @@ two additional boxes (image header and color specification) contained in the JP2 header superbox. XML boxes are not in the minimal set of box requirements for the JP2 format, so -in order to add an XML box into the mix, we'll need to specify all of the -boxes. If you already have a JP2 jacket in place, you can just reuse it, +in order to add an XML box into the mix before the codestream box, we'll need to +re-specify all of the boxes. If you already have a JP2 jacket in place, you can just reuse that, though. Take the following example content in an XML file `favorites.xml` : :: @@ -117,7 +116,8 @@ though. Take the following example content in an XML file `favorites.xml` : :: Light Ale -and add it after the JP2 header box, but before the codestream box :: +In order to add the XML after the JP2 header box, but before the codestream box, +the following will work. :: >>> boxes = jp2.box # The box attribute is the list of JP2 boxes >>> xmlbox = glymur.jp2box.XMLBox(filename='favorites.xml')