pdfmd 1.9.1 → 2.0.0

data/lib/pdfmd/explain.hiera.md

@@ -2,10 +2,12 @@ Information about hiera: https://docs.puppetlabs.com/hiera/1/index.html
 
 Installation:
 
-``` 
+```
 $ gem install hiera
 ```
 
+This is a list of all available hiera settings.
+
 Configure default settings for pdfmd in hiera:
 
 
@@ -14,12 +16,29 @@ Configure default settings for pdfmd in hiera:
   pdfmd::config:
     default:
       password    : secretpassword
+      loglevel    : info|warn|error|debug
     sort:
       copy        : true
       destination : /data/output
       interactive : true
       log         : true
       logfile     : /var/log/pdfmd.log
+    rename:
+      allkeywords : true
+      copy        : true
+      defaultdoctype: doc
+      keywords    : 4
+      outputdir   : /data/output/sorted
+      log         : true
+      logfile     : /var/log/pdfmd.log
+    rename:
+      allkeywords : true
+      copy        : true
+      defaultdoctype: doc
+      keywords    : 4
+      outputdir   : /data/output/sorted
+      log         : true
+      logfile     : /var/log/pdfmd.log
     rename:
       allkeywords : true
       copy        : true
@@ -27,6 +46,8 @@ Configure default settings for pdfmd in hiera:
       keywords    : 4
       outputdir   : /data/output/sorted
     edit:
-     rename       : true
-
-
+      rename      : true
+      opendoc     : true
+      pdfviewer   : evince
+      log         : true
+      logfile     : /var/log/pdfmd.log

data/lib/pdfmd/long_desc.pdfmdconfig.txt

@@ -0,0 +1,40 @@
+  Shows the current default configuration as available in Hiera.
+
+
+  
+  == Usage
+
+  
+  Example: `pdfmd config [<command>]`
+
+  
+  
+  == Parameter
+
+  
+  [<command>]
+
+  
+  Shows only the default configuration from hiera for the specified command.
+  The command parameter is not case-sensitive.
+ 
+ 
+  Example: `pdfmd config edit`
+
+
+
+--log, -l
+
+
+Enables/Disables logging.
+
+
+ Default: true
+
+
+
+ --logfile, -p
+
+
+Path to the logfile. Default: `./.pdfmd.log`
+  

data/lib/pdfmd/long_desc.pdfmdedit.txt

@@ -0,0 +1,166 @@
+== General
+
+Command will edit the metadata of a PDF document. Multiple values can be
+specified or 'all'.
+
+The command will invoke an interactive user input and request the values
+for the metatag if no value is provided.
+
+Additionally the file can be renamed at the end according to the new meta
+  tags. See `pdfmd help rename` for details.
+
+== Parameter
+
+--log, -l
+
+Enables/Disables the logging. Default: true
+
+
+
+--logfile, -p
+
+Path to the standard logfile. Default: ./.pdfmd.log
+
+
+
+--tag, -t
+
+Names or list of names of Metatag fields to set, separated by commata.
+
+If a value is provided, the current Value will be replaced by the new value.
+
+This parameter has no sibling in Hiera and needs to be specified on the command line.
+
+
+
+--rename, -r
+
+Rename file after updating the meta tag information according to the fields.
+
+This parameter is identical to running `pdfmd rename <filename>`.
+
+
+
+== Hiera
+
+      --- #YAML</br>
+        pdfmd::config:
+          edit:
+            rename    : true|false
+            log       : true|false
+            logfile   : /var/log/pdfmd.log
+            opendoc   : true|false
+            pdfviewer : evince
+
+
+opendoc:
+
+If set to true the command will try to start a the pdfviewer specified in 'pdfviewer' and display the PDF document while editing. If all values are being specified to the tags (e.g.: 'author:John Doe'), the pdf viewer will not be started. Only if some user interaction is requested.
+
+The PID of the view process started will be automatically killed when the editing of the document has been finished.
+
+There is no aquivalent command line parameter for this.
+
+
+
+pdfviewer:
+
+Command to run the pdf viewer on the system. Default: evince
+
+There is no aquivalent command line parameter for this.
+
+
+
+== General example:
+
+# Edit tag 'TAG' and set a new value interactive.
+
+$ pdfmd edit -t TAG <filename>
+
+# Edit tag 'Author' and set new value interactive.
+
+$ pdfmd edit -t author example.pdf
+
+# Edit multiple Tags and set a new value interactive.
+
+$ pdfmd edit -t tag1,tag2,tag3 <filename>
+
+# Edit multiple Tags and set a new value in batch mode.
+
+$ pdfmd edit -t tag1:'value1',tag2:'value2' <filename>
+
+
+
+
+== Multiple Tags
+
+For setting multiple tags list the tags comma separated.
+
+For setting all tags (Author, Title, Subject, CreateDate, Keywords) use the keyword 'all' as tagname.
+
+# Set tags 'Author', 'Title', 'Subject' in example.pdf interactivly.
+
+$ pdfmd edit -t author,title,subject example.pdf`
+
+# Set tags 'Author', 'Title', 'Subject', 'CreateDate', 'Keywords' in example.pdf interactive:
+
+$ pdfmd edit -t all example.pdf
+
+# Set tags 'Author', 'CreateDate' in example.pdf in batch mode (non-interactive:
+
+pdfmd edit -t author:'Me',createdate:'1970:00:00 01:01:01' example.pdf
+
+pdfmd edit -t author:'Me',Createdate:19700000 example.pdf
+
+
+
+== Tag: CreateDate
+
+In order to enter a value for the 'CreateDate' field, some internal matching is going on in order to make it easier and faster to enter dates and times.
+
+The following formats are identified/matched:
+
+yyyymmdd
+
+yyyymmd
+
+yyyymmddHHMMSS
+
+yyyy-mm-dd HH:MM:SS
+
+yyyy:mm:dd HH:MM:SS
+
+yyyy.mm.dd HH:MM:SS
+
+yyyy-mm-d
+
+yyyy-mm-dd
+
+yyyy.mm.d
+
+yyyy.mm.dd
+
+yyyy:mm:d
+
+yyyy:mm:dd
+
+- If HH:MM:SS or HHMMSS is not provided, those values are automatically set to zero.
+
+- The output format of every timestamp is <yyyy:mm:dd HH:MM:SS>
+
+- When providing and invalid date, the incorrect date is rejected and the user asked to provide the correct date.
+
+
+
+== Rename file
+
+In addition to setting the tags the current file can be renamed according to
+the new metadata.
+
+# Set tag 'Author' and rename file example.pdf
+
+$ pdfmd edit -t author -r example.pdf
+
+See `pdfmd help rename` for details about renaming.
+
+To enable this feature in hiera add the key 'rename' into the section 'edit' with the value 'true'.

data/lib/pdfmd/long_desc.pdfmdexplain.txt

@@ -0,0 +1,16 @@
+== General
+
+Explain terms used with the script.
+
+
+
+== Example
+
+# Show the available subjects
+
+$ pdfmd explain
+
+# Show information about the subject 'author'
+
+$ pdfmd explain author
+

data/lib/pdfmd/long_desc.pdfmdrename.txt

@@ -0,0 +1,206 @@
+== General
+
+Rename a file with the meta tags in the document.
+
+== Parameter
+
+--dry-run, -n
+
+Simulate the renaming process and show the result without changing the file. Default: false
+
+
+
+--dryrun, -n
+
+Simulate what would be done without actually doing it. Default: false
+
+
+
+--allkeywords, -a
+
+Use all keywords from the meta information in the file name and ignore the limit. Default: false
+
+
+
+--nrkeywwords, -k
+
+Set the number of keywords used in the filename to a new value. Default: 3
+
+
+
+--outputdir, -o
+
+Rename the file and move it to the directory defined in '--outputdir'. Default: ./
+
+
+
+--copy, -c
+
+Copy the file instead of moving it to the new name or destination. Default: false
+
+
+
+--log, -l
+
+Enable logging. Default: true
+
+
+
+--logfile, -p
+
+Define logfile path. Default: ./.pdfmd.log
+
+
+
+== Hiera
+
+--- #YAML
+pdfmd::config:
+  rename:
+    dryrun      : true|false
+    allkeywords : true|false
+    outputdir   : /tmp
+    nrkeywords  : 3
+    copy        : true|false
+    log         : true|false
+    logfile     : /var/log/pdfmd.log
+
+
+
+== Example
+
+# Rename the file according to the metatags
+
+$ pdfmd rename <filename>
+
+# Rename example.pdf according to the metatags
+
+$ pdfmd rename example.pdf
+
+# Simulate renaming example.pdf according to the metatags (dry-run)
+$ pdfmd rename -n example.pdf
+
+
+
+== Hiera
+
+There are Hiera settings available, that cannot be addressed by a commandline parameter.
+
+defaultdoctype: Defines the appreviation for the default document type. This one isused when no other document type could be determined from the metadata-field 'title'. Default value is 'doc'.
+
+For details on how to set the parameter, see 'pdfmd explain hiera'.
+
+
+== Rules
+
+There are some rules regarding how documents are being renamed
+
+Rule 1: All documents have the following filenaming structure:
+
+<yyyymmdd>-<author>-<type>-<additionalInformation>.<extension>
+
+# <yyyymmdd>: Year, month and day identical to the meta information in the document.
+
+# <author>: Author of the document, identical to the meta information
+in the document. Special characters and whitespaces are replaced.
+
+# <type>: Document type, is being generated from the title field in the metadata of the document. Document type is a three character abbreviation following the following logic:
+
+con => Contract
+
+inv => Invoice
+
+inf => Information
+
+man => Manual
+
+off => Offer
+
+ord => Order
+
+rpt => Receipt
+
+tic => Ticket
+
+If the dokument type can not be determined automatically, it defaults to 'dok'.
+
+This default behavior got introduced with version 1.8.1 and can be overwritten by hiera.
+See `pdfmd explain hiera-keys` for information on how to do this.
+
+# <additionalInformation>: Information generated from the metadata fields
+'title', 'subject' and 'keywords'. 
+
+If 'Title' or 'Keywords' contains one of the following keywords, they will be replaced with the corresponding abbreviation followed by the specified value:
+
+Contract    => con
+
+Invoice     => inv
+
+Information => inf
+
+Manual      => man
+
+Offer       => off
+
+Order       => ord
+
+Receipt     => rpt
+
+Ticket      => tic
+
+
+This setting will be overwritten as well by defining the 'keys' hash in Hiera.
+
+Rule 2: The number of keywords used in the filename is defined by the parameter '-k'. See the section of that parameter for more details and the default value.
+
+Rule 3: Keywords matching 'kvi','fak','ord','kdn' are prioritised.
+
+Rule 4: Special characters and whitespaces are replaced: 
+
+' ' => '_'
+
+'/' => '_'
+
+Rule 5: The new filename has only lowercase characters.
+
+
+
+== Example (detailed)
+
+# Example PDF with following MetaTags:
+
+Filename   : example.pdf
+
+Author     : John
+
+Subject    : new Product
+
+Title      : Presentation
+
+CreateDate : 1970:01:01 01:00:00
+
+Keywords   : John Doe, Jane Doe, Mister Doe
+
+
+# Renaming the file
+
+$ pdfmd rename example.pdf
+
+example.pdf => 19700101-john-dok-new_product-john_doe-jane_doe.pdf
+
+
+
+# Simulation to rename the file (no actual change)
+
+pdfmd rename -n example.pdf
+
+example.pdf => 19700101-john-dok-new_product-john_doe-jane_doe.pdf
+
+
+
+# Renaming the file with all keywords
+
+$ pdfmd rename -n -a example.pdf
+
+example.pdf => 19700101-john-dok-new_product-john_doe-jane_doe-mister_doe.pdf
+