Skip to content

missing meta-info in documentation pdf #50151

Closed
Closed
missing meta-info in documentation pdf#50151
Labels
3.10 (EOL)end of life3.11only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

Description

@ZeeD
ZeeD
mannequin
opened on May 2, 2009
BPO 5901
Nosy @birkenfeld, @ned-deily, @ZeeD, @sandrotosi, @berkerpeksag, @CAM-Gerlach
PRs
  • Doc: Fix spurious comma in the author metadata field #32386
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2022-04-08.17:36:17.338>
created_at = <Date 2009-05-02.06:42:56.556>
labels = ['3.11', 'type-bug', '3.9', '3.10', 'docs']
title = 'missing meta-info in documentation pdf'
updated_at = <Date 2022-04-08.17:36:17.326>
user = 'https://github.com/ZeeD'

    bugs.python.org fields:

    activity = <Date 2022-04-08.17:36:17.326>
actor = 'ned.deily'
assignee = 'docs@python'
closed = True
closed_date = <Date 2022-04-08.17:36:17.338>
closer = 'ned.deily'
components = ['Documentation']
creation = <Date 2009-05-02.06:42:56.556>
creator = 'ZeD'
dependencies = []
files = []
hgrepos = []
issue_num = 5901
keywords = ['patch']
message_count = 6.0
messages = ['86931', '86932', '130297', '188834', '262788', '416994']
nosy_count = 7.0
nosy_names = ['georg.brandl', 'ned.deily', 'ZeD', 'sandro.tosi', 'docs@python', 'berker.peksag', 'CAM-Gerlach']
pr_nums = ['32386']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue5901'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

    Activity

    1. ZeeD commented on May 2, 2009

      @ZeeD
      ZeeDmannequin
      on May 2, 2009
      MannequinAuthor

      from http://docs.python.org/download.html and
      http://docs.python.org/3.0/download.html you can download the python
      documentation in many formats (html, pdf, txt), I think auto-generated
      by the .rst source.

      While html and txt does not, the pdf format, supports some simple
      "meta-data" infos about the document: other than the number of pages,
      the page size, the creator, etc... (all auto-filled) there are 4 "keys"
      that the current pdf miss to fill and I think it's important: Title,
      Subject, Keywords, and Author.

      try, for example, to use the simple pdfinfo tool (from
      http://poppler.freedesktop.org/) to inspect the current pdf

      $ tar xvjf python-3.0.1-docs-pdf-a4.tar.bz2
$ cd docs-pdf
$ ls -1
c-api.pdf
distutils.pdf
documenting.pdf
extending.pdf
howto-advocacy.pdf
howto-cporting.pdf
howto-curses.pdf
howto-doanddont.pdf
howto-functional.pdf
howto-regex.pdf
howto-sockets.pdf
howto-unicode.pdf
howto-urllib2.pdf
howto-webservers.pdf
install.pdf
library.pdf
reference.pdf
tutorial.pdf
using.pdf
whatsnew.pdf
$ pdfinfo library.pdf
Title:
Subject:
Keywords:
Author:
Creator:        LaTeX with hyperref package
Producer:       pdfTeX-1.40.9
CreationDate:   Sat Feb 14 11:33:09 2009
ModDate:        Sat Feb 14 11:33:09 2009
Tagged:         no
Pages:          1077
Encrypted:      no
Page size:      595.276 x 841.89 pts (A4)
File size:      7556857 bytes
Optimized:      no
PDF version:    1.4

      erh, what is supposed to contain "using.pdf"? and "distutils.pdf"?

      (Yes, I know what they contain, but...)

      If the pdf were "tagged", not only me, but also my OS will know what's
      in these pdf (see nepomuk/strigi/tracker/beagle programs, helping me
      find what I'm searching

    2. ZeeD
      assigned
      birkenfeld
      on May 2, 2009
    3. ZeeD
      added
      performancePerformance or resource usage
      docsDocumentation in the Doc dir
      on May 2, 2009

    4. birkenfeld commented on May 2, 2009

      @birkenfeld
      birkenfeld
      on May 2, 2009
      Member

      I thought we already did assign these metadata items; looks like it's
      been messed up somehow. I'll fix this.

    5. BreamoreBoy
      assigned
      docspython
      and unassigned
      birkenfeld
      on Jul 20, 2010

    6. sandrotosi commented on Mar 7, 2011

      @sandrotosi
      sandrotosi
      on Mar 7, 2011
      Contributor

      AFAIK, this is obtained using \pdfinfo{} command[1][2][3]

      [1] http://theoval.cmp.uea.ac.uk/~nlct/latex/pdfdoc/pdfdoc/pdfdoc.html
      [2] http://tex.stackexchange.com/questions/5958/is-hyperref-really-the-best-way-to-add-metadata-to-a-tex-file
      [3] http://www.tug.org/applications/hyperref/manual.html#x1-110003.7

      Georg, do you think this is something that sphinx has to handle (in the latex builder) or somewhere else?

    7. akuchling commented on May 10, 2013

      @akuchling
      akuchling
      on May 10, 2013
      Contributor

      This seems to be fixed now. I downloaded python-3.3.1-docs-pdf-letter.tar.bz2 and ran pdfinfo on using.pdf:

      Title: Python Setup and Usage
      Subject:
      Keywords:
      Author: Guido van Rossum, Fred L. Drake, Jr., editor
      Creator: LaTeX with hyperref package
      Producer: pdfTeX-1.40.10
      CreationDate: Fri May 10 09:42:17 2013
      ModDate: Fri May 10 09:42:17 2013
      Tagged: no
      Pages: 65
      Encrypted: no
      Page size: 612 x 792 pts (letter)
      File size: 432316 bytes
      Optimized: no
      PDF version: 1.4

      We could fill in Subject and Keywords, but the basic fields of Title and Author seem to be present. (Do we need to change author to 'Python Development Group' or 'PSF'?)

    8. berkerpeksag commented on Apr 2, 2016

      @berkerpeksag
      berkerpeksag
      on Apr 2, 2016
      Member

      I get the following output when I try Python 3.5.1 docs:

      $ pdfinfo using.pdf 
Title:          
Subject:        
Keywords:       
Author:         
Creator:        LaTeX with hyperref package
Producer:       pdfTeX-1.40.14
CreationDate:   Sat Apr  2 00:17:54 2016
ModDate:        Sat Apr  2 00:17:54 2016
Tagged:         no
Pages:          69
Encrypted:      no
Page size:      595.276 x 841.89 pts (A4)
File size:      368343 bytes
Optimized:      no
PDF version:    1.5
    9. berkerpeksag
      added
      type-bugAn unexpected behavior, bug, or error
      and removed
      performancePerformance or resource usage
      on Apr 2, 2016

    10. ned-deily commented on Apr 8, 2022

      @ned-deily
      ned-deily
      on Apr 8, 2022
      Member

      The problem seems to have been fixed again somewhere in the past.

    11. ned-deily
      added
      3.9 (EOL)end of life
      3.10 (EOL)end of life
      3.11only security fixes
      on Apr 8, 2022
    12. ned-deily
      closed this as completedon Apr 8, 2022
    13. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      3.10 (EOL)end of life3.11only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions