Include a pdf note in the multipage_pdf.py example. Document the PdfPages.attach_note method in the whats_new section.

Ulrich Dobramysl · Ulrich Dobramysl · commit f65281a3d1ef · 2015-01-13T07:46:04.000Z
diff --git a/doc/users/whats_new/pdfpages_notes.rst b/doc/users/whats_new/pdfpages_notes.rst
@@ -0,0 +1,12 @@
+Per-page pdf notes in multi-page pdfs (PdfPages)
+------------------------------------------------
+
+Add a new method attach_note to the PdfPages class, allowing the
+attachment of simple text notes to pages in a multi-page pdf of
+figures. The new note is visible in the list of pdf annotations in a
+viewer that has this facility (Adobe Reader, OSX Preview, Skim,
+etc.). Per default the note itself is kept off-page to prevent it to
+appear in print-outs.
+
+PdfPages.attach_note needs to be called before savefig in order to be
+added to the correct figure.
diff --git a/examples/pylab_examples/multipage_pdf.py b/examples/pylab_examples/multipage_pdf.py
@@ -20,6 +20,8 @@
     x = np.arange(0, 5, 0.1)
     plt.plot(x, np.sin(x), 'b-')
     plt.title('Page Two')
+    pdf.attach_note("plot of sin(x)")  # you can add a pdf note to
+                                       # attach metadata to a page
     pdf.savefig()
     plt.close()
 
