labrat 1.2.1 → 1.2.3

data/README.org

@@ -5,10 +5,15 @@ This is for markdown output:
 [![Build Status](https://travis-ci.org/ddoherty03/labrat.svg?branch=master)](https://travis-ci.org/ddoherty03/labrat)
 
 The following is for org.
-#+END_COMMENT
 
-[[https://travis-ci.org/ddoherty03/labrat.svg?branch=master]]
+NOTE: in order to get the README to render the tilde character properly as
+"code" in org syntax, I used a unicode character, ˜ called TILDE OPERATOR,
+inside regular tildes, like this ~∼∼~.  Though it looks like four tildes in a
+row, its actually tilde - TILDE OPERATOR - TILDE OPERATOR - tilde, which
+renders nicely on Github.
+#+END_COMMENT
 
+[[https://github.com/ddoherty03/labrat/actions/workflows/main.yml/badge.svg]]
 
 * Table of Contents                                                   :toc_4:
 - [[#labrat][Labrat]]
@@ -38,7 +43,7 @@ The following is for org.
       - [[#standard-input][Standard input]]
       - [[#template-exception][Template exception]]
     - [[#printing-or-viewing][Printing or viewing]]
-    - [[#shell-commands][Shell commands]]
+    - [[#printing-and-viewing-shell-commands][Printing and viewing shell commands]]
     - [[#aids-to-testing-label-layouts][Aids to testing label layouts]]
       - [[#page-grid-1][Page Grid]]
       - [[#page-template][Page Template]]
@@ -107,8 +112,8 @@ in any buffer and get it generated with very little ceremony.
 As mentioned, one of my main motivations for writing =labrat= was the need to
 easily create file-folder labels.  I got into creating files after reading
 /Getting Things Done/ by David Allen.  One of his recommendations for keeping
-organized is having a file system so that documents can be easily archived and
-retrieved.
+organized is having a filing system so that documents can be easily archived
+and retrieved.
 
 I have long used Dymo's 30327 label, which is just the right size for file
 folders.  But after several years of use, I started to notice something
@@ -139,28 +144,31 @@ install =labrat= with:
   $ gem install labrat
 #+end_SRC
 
-After installation, you should install the user and system configuration files
+After installation, you should install the user and system (if you have sudo
+privileges) configuration files
 with:
 
 #+begin_SRC sh
   $ labrat-install
 #+end_SRC
 
-This will install an annotated system-wide config file in
-=/etc/xdg/labrat/config.yml= and a system-wide label database in
-=/etc/xdg/labrat/labeldb.yml=.
+This will, assuming you have sudo privileges, install an annotated system-wide
+config file in =/etc/xdg/labrat/config.yml= and a system-wide label database
+in =/etc/xdg/labrat/labeldb.yml=.
 
 It will also install an annotated sample user config file in
-=~/.config/labrat/labrat.el= and a sample user-level label database in
+=~/.config/labrat/labrat.yml= and a sample user-level label database in
 =~/.config/labrat/labeldb.yml=.
 
 For the benefit of Emacs users, it also installs the =labrat.el= elisp library
-in =~/.config/labrat= as well, though you may want to move it to a different
-location.
+in =~/.config/labrat= as well.  You may want to add this directory to your
+~load-path~ or copy, move, or link it to a directory already in your
+~load-path~.
 
 If you invoke =labrat-install= multiple times, it will refuse to overwrite any
 existing config or database files that you may have already installed.  If you
-want to re-install them you have to move the existing files out of the way.
+want to re-install them you have to remove the existing files or move them out
+of the way.
 
 ** Setting options
 You can control how =labrat= composes a label completely from the
@@ -206,7 +214,7 @@ configuration files, string values need not be quoted.
 Labrat can handle multi-label pages such as Avery-style label sheets.  These
 options deal with the page-level dimensions of the, potentially, multi-label
 page.  By contrast, the dimensions of individual labels are dealt with by the
-label setup options described in the next section.
+label setup options described in the [[* Label Setup Options][next]] section.
 
 *** Orientation
 - ~-L~, ~--[no-]landscape~ :: Orient the label grid and the printing direction
@@ -272,12 +280,17 @@ taking the page orientation into account
 - ~--column-gap=DIM~ :: The distance between columns of labels on a page
 
 ** Label Setup Options
-These options determine the layout of individual labels within the page rather
-than the page as a whole.  Note that the dimensions of a single whole label is
-not specified, but is implicitly determined by (1) the page width and height,
-(2) the page margins, (3) the number of rows and columns per page, and (4) the
-row and column gaps.  The remaining space on the page is divided into a grid
-of identically-sized labels, which determines the size of each label.
+These options determine the layout of individual labels within the page grid
+rather than the page grid as a whole.  Note that the dimensions of a single
+whole label is not specified, but is implicitly determined by:
+
+1. the page width and height,
+2. the page margins
+3. the number of rows and columns per page, and
+4. the row and column gaps.
+
+The remaining space on the page is divided into a grid of identically-sized
+labels, which determines the size of each label.
 
 *** Padding
 Within each label, the following options allow you to set the margins on each
@@ -302,7 +315,7 @@ label, but the following options allow you to alter that.
   label (default center)
 
 *** Fonts and styling
-=labrat= provides a few simple mean for styling the label text.  Note that all
+=labrat= provides a few simple means for styling the label text.  Note that all
 of these apply to the whole label text: there is no provision yet for doing
 in-line changes of font styles.
 
@@ -346,18 +359,18 @@ later pages always start on the first label position.
 
 *** New line marker
 You can embed a special text-sequence in the label text to indicate where a
-line-break should occur.  By default it is the sequence = ~~ =.  This means
-that =labrat= will translate all occurrences of = ~~ = in the text into a
-line-break, even consecutive occurrences.  There is no way to escape this in
-the text, so if you want labels for that use ' ~~ ' as part of the text, you
-are going to have difficulty printing a labels.  But you can change the marker
-to something else with ~--nlsep~.  This is especially helpful when you are
-using the command-line to supply the label text since specifying line-breaks
-on a shell command can be difficult.  However note that this substitution
-takes place even when reading label texts from a file or standard input.
+line-break should occur.  By default it is the sequence =∼∼=.  This means that
+=labrat= will translate all occurrences of =∼∼= in the text into a line-break,
+even consecutive occurrences.  There is no way to escape this in the text, so
+if you want labels that use =∼∼= as part of the text, you are going to have
+difficulty printing.  But you can change the marker to something else with
+~--nlsep~.  This is especially helpful when you are using the command-line to
+supply the label text since specifying line-breaks on a shell command can be
+difficult.  However note that this substitution takes place even when reading
+label texts from a file or standard input.
 
 - ~-n~, ~--nlsep=SEPARATOR~ :: Specify text to be translated into a line-break
-  (default ' ~~ ')
+  (default ' =∼∼= ')
 
 *** Label separator
 The only way to print more than one label from the command-line is to indicate
@@ -449,7 +462,7 @@ disregarding comments.
 
 **** Template exception
 Notwithstanding all of the above, if the ~-T~ (~--template~) option is given
-(see below at [[*Aids to testing label layouts][Aids to testing label layouts]]), all label texts from the
+(see below at [[* Aids to testing label layouts]]), all label texts from the
 command-line, an ~in-file~, or standard input are ignored and a template is
 generated.
 
@@ -461,7 +474,7 @@ command from ~--view-command~ to view the generated PDF file instead.
 
 - ~-V~, ~--[no-]view~ :: View rather than print
 
-*** Shell commands
+*** Printing and viewing shell commands
 By default, =labrat= uses the shell command:
 #+begin_example
 lpr -P %p %o
@@ -502,8 +515,7 @@ setting the ~--delta-x~ or ~--delta-y~ values for your setup.
 
 Normally, =labrat= does not print an outline for the labels, but if you are
 testing things out on plain paper, it helps to know where =labrat= thinks the
-boundaries of the labels are.  That is what the ~--grid~ or ~-g~ options
-provide.
+boundaries of the labels are.  The ~--grid~ or ~-g~ options provide this.
 
 - ~-g~, ~--[no-]grid~ :: Add grid lines to output
 
@@ -511,7 +523,7 @@ provide.
 When trying to define a new label layout, it also helps to just see what a
 single sheet of labels would look like.  That is what the ~--template~ (or
 ~-T~) option gives you: it just prints an outline of where labels would be
-printed but ignores any label text.
+printed and numbers the labels, but it ignores any label text.
 
 - ~-T~, ~--[no-]template~ :: Print a template of a page of labels and ignore
   any content
@@ -519,7 +531,8 @@ printed but ignores any label text.
 **** Verbose Reporting
 Finally, =labrat= will print a lot of information about what it's doing with
 the ~--verbose~ or ~-v~ option.  The information is printed to the standard
-error output stream.
+error output stream.  This is particularly helpful in determining how the
+final configuration was constructed from the various config files.
 
 - ~-v~, ~--[no-]verbose~ :: Run verbosely, that is, print out lots of
   information about what =labrat= is doing as it processes the job.
@@ -527,7 +540,7 @@ error output stream.
 ** The Label Database and the label option
 One of the nice things about =labrat= is that it comes with a database of
 pre-defined label configurations for many standard labels, especially Avery
-labels since they are kind enough to publish PDF templates for all their
+labels since they were good enough to publish PDF templates for all their
 products at [[https://www.avery.com/templates]].
 
 *** Listing labels
@@ -583,7 +596,7 @@ avery8986:
   label: avery8987
 #+end_example
 In other words, it defines the ~avery8986~ label with a nested ~--label~
-option that simply refers to the ~avery8987~ entry.
+option that simply incorporates the ~avery8987~ entry settings.
 
 *** Label database entries as configuration sets
 This ability to use a label database definition as an alias for a whole set of

data/Rakefile

@@ -9,4 +9,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec]
+task :default => [:spec, :rubocop]

data/bin/labrat

@@ -40,7 +40,6 @@ begin
   else
     lab.print
   end
-
 rescue Labrat::OptionError => e
   warn "Error: #{e}: exiting"
   exit(1)

data/labrat.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
     For Emacs users, labrat includes elisp code for invoking labrat from within a
     buffer, providing a quick way to print labels.
 
-DESC
+  DESC
 
-  spec.homepage      = "http://github.com/ddoherty03/labrat"
+  spec.homepage = "http://github.com/ddoherty03/labrat"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -42,17 +42,9 @@ DESC
   spec.executables   = spec.files.grep(%r{\Abin/labrat}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.post_install_message = 'To install config and label database files, run labrat-install.'
-  spec.add_dependency "matrix"
-  spec.add_dependency "prawn", "~> 2.0"
   spec.add_dependency "activesupport"
+  spec.add_dependency "fat_config", '>=0.4.2'
   spec.add_dependency "fat_core"
-
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'debug', '>= 1.0.0'
-  spec.add_development_dependency 'rubocop-performance'
-  spec.add_development_dependency 'rubocop-shopify'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_dependency "matrix"
+  spec.add_dependency "prawn", "~> 2.0"
 end

data/lib/config_files/labeldb.yml

@@ -1009,3 +1009,20 @@ avery88662:
 
 avery95662:
   label: avery18662
+
+# Divider Tabs
+# 07708, 07712, 07714, 07720, 11110, 11113, 11121, 11122, 11160, 11178, 11185,
+# 11220, 11221, 11227, 11273, 11835, 11900, 11902, 11906, 11908, 11956, 11982,
+# 11988, 23280, 23281, 71109, 71900, 71906, 81310
+avery11109:
+  page-width: 8.5in
+  page-height: 11in
+  rows: 20
+  columns: 2
+  top-page-margin: 13mm
+  bottom-page-margin: 13mm
+  left-page-margin: 70mm
+  right-page-margin: 70mm
+  row-gap: 0mm
+  column-gap: 0mm
+  landscape: false