lncs 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63fbbffcc26dbaacb60e48a62ab1a77eac72866f
-  data.tar.gz: ef1cb06fccdbbca36ce241eaeb801bd1f2feb5f1
+  metadata.gz: f3de00673d581c89be60c43b8ff473d954a03935
+  data.tar.gz: eb50c91da8b17f4ad38c2dd009f16fa2196d3071
 SHA512:
-  metadata.gz: a1c1e4870fd5f088bfee642d8bd84470b23b3b2de741f36460ede4508eadc2bdec7f6b72a5b63509ed79e8be03e8e8772c2ec26e9241e6b420b21f44e0b85ebd
-  data.tar.gz: f23fc26134fc393200ed20b2ce3bffa4b3b1a5a18bf5a2ea9d997cdd87c9ac5fc73ec7f4031d9cb4f03ac7bf28f4ca8666564d732a4e830c992f1dea9c409361
+  metadata.gz: aa15a05e0d61eea59b172140a96c70d8af319af01d0718d1d06bc0f5c3173de414e7568d6f536b1398556c8d92a8538ddd5ccf82f2ec1d566149ce4b66fcf4f9
+  data.tar.gz: 5dd0289c441d75899fb187a07bf26f63bc3cc1c9f2e1976bc8008c32d10e80b1ad159664114115a078e2b44d110d21a676327bbc7a2786236a4424b0df946252

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lncs (0.0.3)
+    lncs (0.0.4)
       json (~> 1.7)
       pdf-reader (~> 1.3)
       thor (~> 0.18)

data/README.md

@@ -10,20 +10,22 @@ You'll need to install Ruby 1.9 or later. I recommend doing so via [rvm](https:/
 
 You can then install `lncs` via Ruby gems: `gem install lncs`
 
-Get started with the `lncs` executable: `lncs help`
-
 Recommended workflow
 --------------------
+Creating a Springer LNCS proceedings with `lncs` involves two activities: ensuring that `lncs` has sufficient information about your proceedings and submissions (steps 1-5, below), and using `lncs` to generate all of the artefacts that Springer require for an LNCS proceedings (steps 7-11).
 
-1. Download the submissions for your volume
+1. Download the submissions for your proceedings (e.g., from EasyChair). Please note that:
+    * `lncs` works best for submissions that are packaged as a single ZIP file that contains both the LaTeX source and a compiled PDF.
+    * `lncs` can also be used for submissions that do not include LaTeX source files, or that are packaged as a single PDF file. For submissions that do not include LaTeX source files, you will need to specify some extra information in the manifest (more details below). 
+    * `lncs` does not work with submissions packages as MS Word files.
 
-2. Setup a working directory
+2. Create a new working directory:
 
         > mkdir ecmfa2013
         > cd ecmfa2013
         > lncs init    
 
-3. Customise the manifest (e.g., set the path to the submissions, the volume number, ...)
+3. Setup the manifest (e.g., set the path to the submissions, the volume number, ...)
 
         > vi manifest.json
         > cat manifest.json
@@ -42,24 +44,43 @@ Recommended workflow
           ]
         }
     
-4. Unpack and inspect all of the submissions
+4. Use `lncs inspect` to decompress any submissions packaged as ZIP files, and to locate compiled PDF files:
 
         > lncs inspect
-        > cd submissions
-        > ls -R
-    
-        ./ecmfa2013_submission_07:
-        7
-        ./ecmfa2013_submission_07/7:
-        paper7.tex   paper7.pdf   copyright.pdf
-    
-        ./ecmfa2013_submission_24:
-        ECMFA2013-cameraready.pdf   ECMFA2013-cameraready.docx  copyright.pdf
-
-
-5. Update the manifest with the paths to the PDF files of each paper
-
+        Inspecting paper 7 at submissions/ecmfa2013_submission_07/*
+        Inspecting paper 11 submissions/ecmfa2013_submission_11/*
+        ...
+        Updating manifest.json
+        
+        > cat manifest.json
+        {
+          "volume_number": 7949,
+          "sources": "/Users/louis/Downloads/submissions",
+          "sections": [
+            {
+              "title": "Foundations",
+              "papers": [7,11,14,18,20,24,35,46,63]
+            },
+            {
+              "title": "Applications",
+              "papers": [2,6,22,29,58,68]
+            }
+          ],
+          "papers": {
+            "7" : {
+              "pdf": "7/paper.pdf"
+            },
+            "24" : {
+              "pdf": ["ECMFA2013-cameraready.pdf", "figure1.pdf"]
+              "FIXME": "Reduce the PDF key from an array to a single value which corresponds to the compiled PDF."
+            }
+          }
+        }
+        
+5. Your manifest will now contain a `papers` key for each submission that is distributed as a ZIP file. Search for any "FIXME" keys that have been inserted by `lncs inspect` and correct any erroneous `pdf` key values. (Each submission should have a single value for the `pdf` key).
+        
         > vi manifest.json
+        # Deleted the line: "pdf": "figure1.pdf"
         > cat manifest.json
         {
           "volume_number": 7949,
@@ -79,12 +100,14 @@ Recommended workflow
               "pdf": "7/paper.pdf"
             },
             "24" : {
-              "pdf": "ECMFA2013-cameraready.pdf"
+              "pdf": "ECMFA2013-cameraready.pdf",
             }
           }
         }
+        
+    Note that the `pdf` key should contain the relative path to the PDF file in any submission packaged as a ZIP file.
 
-6. Check the status of the submissions 
+6. Once your manifest has been finalised. All of the other `lncs` subcommand will work. Start by checking the status of the submissions:
 
         > lncs report
         Foundations
@@ -105,9 +128,9 @@ Recommended workflow
         058 -- 13pgs zip
         068 -- 11pgs zip
 
-  If a submission exceeds your page limit, you may wish to contact the authors. If a submission is a PDF rather than a ZIP file, you may wish to do the same as you will need to send to Springer the sources and a signed copyright form for each submission.
+  If a submission exceeds your page limit, you may wish to contact the authors. If a submission is a PDF rather than a ZIP file, you may wish to do the same as you will need to send to Springer the LaTeX sources (and a signed copyright form).
 
-7. Generate the set of directories required by Springer for the body of the proceedings
+7. Generate the set of directories required by Springer for the body of the proceedings:
 
         > lncs body
         > ls body
@@ -120,21 +143,26 @@ Recommended workflow
         body/79490001/7:
         paper7.tex   paper7.pdf   copyright.pdf
     
-8. Generate the title pages used to construct the table of contents and author index
+8. Generate the title pages used to construct the table of contents and author index:
 
         > lncs titles
         > ls titles
         0001.tex  0020.tex  0054.tex  0086.tex  0119.tex  0152.tex  0178.tex  0204.tex  index.tex
         0003.tex  0037.tex  0070.tex  0102.tex  0135.tex  0165.tex  0191.tex  0217.tex
     
-9. Run LaTeX to produce your PDF
+9. Run LaTeX to produce your PDF:
 
-        > latex2pdf main.tex
+        > latex2pdf main.tex > main.pdf
         > open main.pdf
     
-10. Override any titles or names of authors (because, for example, `lncs` cannot extract title page information from MS Word source files).
+10. Inspect your PDF to ensure that all of the titles and names of authors are correct in the table of contents. Note that:
+
+    * `lncs titles` works best for submissions that include LaTeX source files.
+    * `lncs titles` extracts the contents of the \title and \author LaTeX tags verbatim. If an author has used non-standard or custom LaTeX commands in their \title and \author declarations, you may need to manually specify the title and authors of this submission in the `lncs` manifest (as described below).
+    * `lncs titles` cannot extract title page information from MS Word or PDF files. You must manually specify the title and authors of submissions containing no LaTeX source in the `lncs` manifest (as described below).
+
+You can override any titles or names of authors in the manifest file. For example:
 
-        > vi manifest.json
         > cat manifest.json
         {
           "volume_number": 7949,
@@ -155,16 +183,22 @@ Recommended workflow
               "title": "MOCQL: A Declarative Language for Ad-Hoc Model Querying",
               "authors": ["Harald St\\\"orrle"]
             },
+            "20" : { 
+              "title" : "Model-based Generation of Run-time Monitors for AUTOSAR",
+              "authors" : ["Lars Patzina", "Sven Patzina", "Thorsten Piper", "Paul Manns"]
+            },
             "24" : {
               "pdf": "ECMFA2013-cameraready.pdf"
             }
           }
         }
+        
+If a title or author must contain a LaTeX command, ensure that your JSON is properly escaped. For example, the LaTeX command `\"` becomes `\\\"` in the manifest as backslashes and quotes are escaped in JSON.
 
 11. Regenerate your titles and PDF.
 
         > lncs titles
-        > latex2pdf main.tex
+        > latex2pdf main.tex > main.pdf
         > open main.pdf
 
 

data/lib/lncs/cli.rb

@@ -17,10 +17,11 @@ module LNCS
       create_file 'titles/index.tex'
     end
 
-    desc "inspect", "Unpack the submissions so that their contents can be inspected manually"
+    desc "inspect", "Inspect the submissions and prepare manifest for the lncs report, body and titles subcommands."
     def inspect
       remake_directory("submissions")
       proceedings.copy_to("submissions")
+      proceedings.add_papers_to_manifest
     end
 
     desc "body", "Generate the set of directories containing the body of the report, in the format required by Springer LNCS"

data/lib/lncs/paper.rb

@@ -32,7 +32,6 @@ module LNCS
     end
   
     def generate_title_to(dst, start_page)
-      raise "Error: Cannot generate title from PDF for paper ##{id}" if type == "pdf"
       check_pdf_exists
     
       captured = title_page_from_manifest_or_latex
@@ -61,6 +60,29 @@ module LNCS
         actions.copy_file(path, File.join(dst, name))
       end
     end
+    
+    def data_for_manifest(existing_data)
+      if existing_data.key?(id)
+        { id => existing_data[id] }
+        
+      elsif type == "zip"
+        data = { pdf: paths_to_pdfs }
+        
+        case data[:pdf].size
+        when 1
+          data[:pdf] = data[:pdf].first
+        when 0
+          data[:FIXME] = "Change the PDF key to the path (relative, within the ZIP) of the compiled PDF."
+        else
+          data[:FIXME] = "Reduce the PDF key from an array to a single value which corresponds to the compiled PDF." 
+        end
+
+        { id => data }
+      
+      else
+        {}
+      end
+    end
   
     def page_count
       check_pdf_exists
@@ -78,6 +100,19 @@ module LNCS
       end
     end
     
+    # Locate all PDF files within the ZIP
+    def paths_to_pdfs
+      paths = []
+      
+      Zip::ZipFile.open(path) do |zipfile|
+        zipfile.select { |file| zipfile.get_entry(file).file? }.each do |file|
+          paths << file.name if file.name.end_with? ".pdf"
+        end
+      end
+      
+      paths
+    end
+    
     def open_pdf      
       if type == "zip"
         extracted_pdf = File.join(Dir.tmpdir, pdf)
@@ -129,6 +164,7 @@ module LNCS
   \\author{#{authors_from_manifest_or_latex.join(" \\and ")}}\n
   """
       else
+        raise "Error: lncs cannot extract title and authors from a PDF file. Please specify the title and authors in the manifest for paper ##{id})" if type == "pdf"
         captured = ""
         each_tex do |tex|
           capturing = false

data/lib/lncs/proceedings.rb

@@ -46,6 +46,13 @@ module LNCS
     def copy_to(dst)
       sections.each { |section| section.copy_to(dst) }
     end
+    
+    def add_papers_to_manifest
+      new_papers = sections.reduce({}) { |data, section| data.merge(section.paper_data_for_manifest(papers)) }
+      new_manifest = manifest.dup
+      new_manifest["papers"] = new_papers
+      actions.create_file("manifest.json", JSON.pretty_generate(new_manifest))
+    end
 
     def generate_body_to(dst)
       start_page = 1

data/lib/lncs/section.rb

@@ -21,6 +21,10 @@ module LNCS
     def copy_to(dst)
       papers.each { |paper| paper.copy_to("#{dst}/#{paper.id}") }
     end
+    
+    def paper_data_for_manifest(existing_data)
+      papers.reduce({}) { |data, paper| data.merge(paper.data_for_manifest(existing_data)) }
+    end
   
     def generate_body_to(dst, volume_number, start_page)
       papers.each do |paper|

data/lib/lncs/version.rb

@@ -1,3 +1,3 @@
 module LNCS
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/templates/manifest.json

@@ -17,20 +17,5 @@
       "title": "Applications",
       "papers": [2,6,22,29,58,68]
     }
-  ],
-  
-  // Include the papers key to indicate the location of the PDF file for each submission
-  "papers": {
-    "7" : {
-      "pdf": "7/paper7.pdf",
-      // You can optionally override the title and list of authors for any paper too
-      "title": "MOCQL: A Declarative Language for Ad-Hoc Model Querying",
-      // You can use LaTeX in the names of authors (and titles), but be sure to escape
-      // any backslashes (for the JSON parser)
-      "authors": ["Harald St\\\"orrle"]
-    },
-    "24" : {
-      "pdf": "ECMFA2013-cameraready.pdf"
-    }
-  }
+  ]
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lncs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Louis M. Rose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json