hexapdf 0.44.0 → 0.46.0

data/lib/hexapdf/document/layout.rb

@@ -77,9 +77,9 @@ module HexaPDF
     #
     # One style property, Layout::Style#font, is handled specially:
     #
-    # * If no font is set on a style, the font "Times" is automatically set because otherwise there
-    #   would be problems with text drawing operations (font is the only style property that has no
-    #   valid default value).
+    # * If no font is set on a style, the default font specified via the configuration option
+    #   'font.default' is automatically set because otherwise there would be problems with text
+    #   drawing operations (font is the only style property that has no valid default value).
     #
     # * Standard style objects only allow font wrapper objects to be set via the Layout::Style#font
     #   method. This class makes usage easier by allowing strings or an array [name, options_hash]
@@ -151,7 +151,9 @@ module HexaPDF
         # :nodoc:
         def method_missing(name, *args, **kwargs, &block)
           if @layout.box_creation_method?(name)
-            @children << @layout.send(name, *args, **kwargs, &block)
+            box = @layout.send(name, *args, **kwargs, &block)
+            @children << box
+            box
           else
             super
           end
@@ -175,9 +177,6 @@ module HexaPDF
 
       end
 
-      # The mapping of style name (a Symbol) to Layout::Style instance.
-      attr_reader :styles
-
       # Creates a new Layout object for the given PDF document.
       def initialize(document)
         @document = document
@@ -219,6 +218,21 @@ module HexaPDF
         style
       end
 
+      # :call-seq:
+      #    layout.styles            -> styles
+      #    layout.styles(**mapping)   -> styles
+      #
+      # Returns the mapping of style names to Layout::Style instances. If +mapping+ is provided,
+      # also defines the given styles using #style.
+      #
+      # The argument +mapping+ needs to be a hash mapping a style name (a Symbol) to style
+      # properties. The special key +:base+ can be used to define the base style. For details see
+      # #style.
+      def styles(**mapping)
+        mapping.each {|name, properties| style(name, **properties) } unless mapping.empty?
+        @styles
+      end
+
       # Creates an inline box for use together with text fragments.
       #
       # The +valign+ argument ist used to specify the vertical alignment of the box within the text
@@ -342,6 +356,7 @@ module HexaPDF
                                       width: width, height: height, properties: properties,
                                       style: box_style)
       end
+      alias text text_box
 
       # Creates a HexaPDF::Layout::TextBox like #text_box but allows parts of the text to be
       # formatted differently.
@@ -444,6 +459,7 @@ module HexaPDF
         box_class_for_name(:text).new(items: data, width: width, height: height,
                                       properties: properties, style: box_style)
       end
+      alias formatted_text formatted_text_box
 
       # Creates a HexaPDF::Layout::ImageBox for the given image.
       #
@@ -465,6 +481,7 @@ module HexaPDF
         box_class_for_name(:image).new(image: image, width: width, height: height,
                                        properties: properties, style: style)
       end
+      alias image image_box
 
       # This helper class is used by Layout#table_box to allow specifying the keyword arguments used
       # when converting cell data to box instances.
@@ -483,8 +500,25 @@ module HexaPDF
           @number_of_columns = number_of_columns
         end
 
-        # Stores the keyword arguments in +args+ for the given 0-based rows and columns which can
-        # either be a single number or a range of numbers.
+        # Stores the hash +args+ containing styling properties for the cells specified via the given
+        # 0-based rows and columns.
+        #
+        # Rows and columns can either be single numbers, ranges of numbers or stepped ranges (i.e.
+        # Enumerator::ArithmeticSequence instances).
+        #
+        # Examples:
+        #
+        #   # Gray background for all cells
+        #   args[] = {cell: {background_color: "gray"}}
+        #
+        #   # Cell at (2, 3) gets a bigger font size
+        #   args[2, 3] = {font_size: 50}
+        #
+        #   # First column of every row has bold font
+        #   args[0..-1, 0] = {font: 'Helvetica bold'}
+        #
+        #   # Every second row has a blue background
+        #   args[(0..-1).step(2)] = {cell: {background_color: "blue"}}
         def []=(rows = 0..-1, cols = 0..-1, args)
           rows = adjust_range(rows.kind_of?(Integer) ? rows..rows : rows, @number_of_rows)
           cols = adjust_range(cols.kind_of?(Integer) ? cols..cols : cols, @number_of_columns)
@@ -497,7 +531,7 @@ module HexaPDF
         # is merged.
         def retrieve_arguments_for(row, col)
           @argument_infos.each_with_object({}) do |arg_info, result|
-            next unless arg_info.rows.cover?(row) && arg_info.cols.cover?(col)
+            next unless arg_info.rows.include?(row) && arg_info.cols.include?(col)
             if arg_info.args[:cell]
               arg_info.args[:cell] = (result[:cell] || {}).merge(arg_info.args[:cell])
             end
@@ -510,7 +544,8 @@ module HexaPDF
         # Adjusts the +range+ so that both the begin and the end of the range are zero or positive
         # integers smaller than +max+.
         def adjust_range(range, max)
-          (range.begin % max)..(range.end % max)
+          r = (range.begin % max)..(range.end % max)
+          range.kind_of?(Range) ? r : r.step(range.step)
         end
 
       end
@@ -528,7 +563,8 @@ module HexaPDF
       # Additional arguments for the #text_box invocations can be specified using the optional block
       # that yields a CellArgumentCollector instance. This allows customization of the text boxes.
       # By specifying the special key +:cell+ it is also possible to assign style properties to the
-      # cells themselves.
+      # cells themselves, irrespective of the type of content of the cells. See
+      # CellArgumentCollector#[]= for details.
       #
       # See HexaPDF::Layout::TableBox::new for details on +column_widths+, +header+, +footer+, and
       # +cell_style+.
@@ -574,6 +610,7 @@ module HexaPDF
                                        footer: footer, cell_style: cell_style, width: width,
                                        height: height, properties: properties, style: style)
       end
+      alias table table_box
 
       LOREM_IPSUM = [ # :nodoc:
         "Lorem ipsum dolor sit amet, con\u{00AD}sectetur adipis\u{00AD}cing elit, sed " \
@@ -593,22 +630,13 @@ module HexaPDF
       def lorem_ipsum_box(sentences: 4, count: 1, **text_box_properties)
         text_box(([LOREM_IPSUM[0, sentences].join(" ")] * count).join("\n\n"), **text_box_properties)
       end
+      alias lorem_ipsum lorem_ipsum_box
 
-      BOX_METHOD_NAMES = [:text, :formatted_text, :image, :table, :lorem_ipsum] #:nodoc:
-
-      # Allows creating boxes using more convenient method names:
-      #
-      # * #text for #text_box
-      # * #formatted_text for #formatted_text_box
-      # * #image for #image_box
-      # * #lorem_ipsum for #lorem_ipsum_box
-      # * The name of a pre-defined box class like #column will invoke #box appropriately. Same if
-      #   used with a '_box' suffix.
+      # Allows creating boxes using more convenient method names: The name of a pre-defined box
+      # class like #column will invoke #box appropriately. Same if used with a '_box' suffix.
       def method_missing(name, *args, **kwargs, &block)
         name_without_box = name.to_s.sub(/_box$/, '').intern
-        if BOX_METHOD_NAMES.include?(name)
-          send("#{name}_box", *args, **kwargs, &block)
-        elsif @document.config['layout.boxes.map'].key?(name_without_box)
+        if @document.config['layout.boxes.map'].key?(name_without_box)
           box(name_without_box, *args, **kwargs, &block)
         else
           super
@@ -620,6 +648,8 @@ module HexaPDF
         box_creation_method?(name) || super
       end
 
+      BOX_METHOD_NAMES = [:text, :formatted_text, :image, :table, :lorem_ipsum] #:nodoc:
+
       # :nodoc:
       def box_creation_method?(name)
         name = name.to_s.sub(/_box$/, '').intern
@@ -636,8 +666,8 @@ module HexaPDF
         end
       end
 
-      # Retrieves the appropriate HexaPDF::Layout::Style object based on the +style+ and +properties+
-      # arguments.
+      # Retrieves the appropriate HexaPDF::Layout::Style object based on the +style+ and
+      # +properties+ arguments.
       #
       # The +style+ argument specifies the style to retrieve. It can either be a registered style
       # name (see #style), a hash with style properties or +nil+. In the latter case the registered
@@ -646,15 +676,18 @@ module HexaPDF
       # If the +properties+ hash is not empty, the retrieved style is duplicated and the properties
       # hash is applied to it.
       #
-      # Finally, a default font (the one from the :base style or otherwise 'Times') is set if
-      # necessary to ensure that the style object works in all cases.
+      # Finally, a default font (the one from the :base style or otherwise the one set using the
+      # configuration option 'font.default') is set if necessary to ensure that the style object
+      # works in all cases.
       def retrieve_style(style, properties = nil)
         if style.kind_of?(Symbol) && !@styles.key?(style)
           raise HexaPDF::Error, "Style #{style} not defined"
         end
         style = HexaPDF::Layout::Style.create(@styles[style] || style || @styles[:base])
         style = style.dup.update(**properties) unless properties.nil? || properties.empty?
-        style.font(@styles[:base].font? && @styles[:base].font || 'Times') unless style.font?
+        unless style.font?
+          style.font(@styles[:base].font? && @styles[:base].font || @document.config['font.default'])
+        end
         unless style.font.respond_to?(:pdf_object)
           name, options = *style.font
           style.font(@document.fonts.add(name, **(options || {})))

data/lib/hexapdf/document.rb

@@ -278,8 +278,9 @@ module HexaPDF
     # If the same argument is provided in multiple invocations, the import is done only once and
     # the previously imported object is returned.
     #
-    # Note: If you first create a PDF document from scratch and then want to import objects from it
-    # into another PDF document, you need to run the following on the source document:
+    # Note: If you first create a PDF document from scratch or if you modify an existing document,
+    # and then want to import objects from it into another PDF document, you need to run the
+    # following on the source document:
     #
     #   doc.dispatch_message(:complete_objects)
     #   doc.validate
@@ -701,6 +702,27 @@ module HexaPDF
       result
     end
 
+    # Returns an in-memory copy of the PDF document.
+    #
+    # In the context of this method this means that the returned PDF document contains the same PDF
+    # object tree as this document, starting at the trailer. A possibly set encryption is not
+    # transferred to the returned document.
+    #
+    # Note: If this PDF document was created from scratch or if it is an existing document that was
+    # modified, the following commands need to be run on this document beforehand:
+    #
+    #   doc.dispatch_message(:complete_objects)
+    #   doc.validate
+    #
+    # This ensures that all the necessary PDF structures set-up correctly.
+    def duplicate
+      dest = HexaPDF::Document.new
+      dupped_trailer = HexaPDF::Importer.copy(dest, trailer, allow_all: true)
+      dest.revisions.current.trailer.value.replace(dupped_trailer.value)
+      dest.trailer.delete(:Encrypt)
+      dest
+    end
+
     # :call-seq:
     #   doc.write(filename, incremental: false, validate: true, update_fields: true, optimize: false)
     #   doc.write(io, incremental: false, validate: true, update_fields: true, optimize: false)

data/lib/hexapdf/font/type1/character_metrics.rb

@@ -51,7 +51,7 @@ module HexaPDF
         attr_accessor :name
 
         # Character bounding box as array of four numbers, specifying the x- and y-coordinates of
-        # the bottom left corner and the x- and y-coordinates of the top right corner.
+        # the bottom-left corner and the x- and y-coordinates of the top-right corner.
         attr_accessor :bbox
 
       end

data/lib/hexapdf/font/type1/font_metrics.rb

@@ -63,7 +63,7 @@ module HexaPDF
         attr_accessor :weight
 
         # The font bounding box as array of four numbers, specifying the x- and y-coordinates of the
-        # bottom left corner and the x- and y-coordinates of the top right corner.
+        # bottom-left corner and the x- and y-coordinates of the top-right corner.
         attr_accessor :bounding_box
 
         # The y-value of the top of the capital H (or 0 or nil if the font doesn't contain a capital

data/lib/hexapdf/importer.rb

@@ -71,14 +71,18 @@ module HexaPDF
     # Imports the given +object+ (belonging to the +source+ document) by completely copying it and
     # all referenced objects into the +destination+ object.
     #
+    # If the +allow_all+ argument is set to +true+, then the usually omitted catalog and page tree
+    # node objects (see the class description for details) are also copied which allows one to make
+    # an in-memory duplicate of a HexaPDF::Document object.
+    #
     # Specifying +source+ is optionial if it can be determined through +object+.
     #
     # After the operation is finished, all state is discarded. This means that another call to this
     # method for the same object will yield a new - and different - object. This is in contrast to
     # using ::for together with #import which remembers and returns already imported objects (which
     # is generally what one wants).
-    def self.copy(destination, object, source: nil)
-      new(NullableWeakRef.new(destination)).import(object, source: source)
+    def self.copy(destination, object, allow_all: false, source: nil)
+      new(NullableWeakRef.new(destination), allow_all: allow_all).import(object, source: source)
     end
 
     private_class_method :new
@@ -86,9 +90,10 @@ module HexaPDF
     attr_reader :destination #:nodoc:
 
     # Initializes a new importer that can import objects to the +destination+ document.
-    def initialize(destination)
+    def initialize(destination, allow_all: false)
       @destination = destination
       @mapper = {}
+      @allow_all = allow_all
     end
 
     SourceWrapper = Struct.new(:source) #:nodoc:
@@ -136,7 +141,7 @@ module HexaPDF
         internal_import(wrapper.source.object(object), wrapper)
       when HexaPDF::Object
         wrapper.source ||= object.document
-        if object.type == :Catalog || object.type == :Pages
+        if !@allow_all && (object.type == :Catalog || object.type == :Pages)
           @mapper[object.data] = nil
         elsif (mapped_object = @mapper[object.data]&.__getobj__) && !mapped_object.null?
           mapped_object
@@ -149,7 +154,12 @@ module HexaPDF
           obj.data.gen = 0
           @destination.add(obj) if object.indirect?
 
-          obj.data.stream = obj.data.stream.dup if obj.data.stream.kind_of?(String)
+          stream = obj.data.stream
+          if stream.kind_of?(String)
+            obj.data.stream = stream.dup
+          elsif stream&.source.kind_of?(FiberDoubleForString)
+            obj.data.stream = stream.fiber.resume.dup
+          end
           obj.data.value = duplicate(obj.data.value, wrapper)
           obj.data.value.update(duplicate(object.copy_inherited_values, wrapper)) if object.type == :Page
           obj

data/lib/hexapdf/layout/box.rb

@@ -69,6 +69,10 @@ module HexaPDF
     #     If the subclass supports the value :flow of the 'position' style property, this method
     #     needs to be overridden to return +true+.
     #
+    #     Additionally, if a box object uses flow positioning, #fit_result.x should be set to the
+    #     correct value since Frame#fit can't determine this and uses Frame#left in the absence of a
+    #     set value.
+    #
     # #empty?::
     #     This method should return +true+ if the subclass won't draw anything when #draw is called.
     #
@@ -89,28 +93,13 @@ module HexaPDF
     #     This method draws the box specific content and is called from #draw which already handles
     #     things like drawing the border and background. So #draw should usually not be overridden.
     #
-    # This base class provides various private helper methods for use in the above methods:
-    #
-    # +reserved_width+, +reserved_height+::
-    #     Returns the width respectively the height of the reserved space inside the box that is
-    #     used for the border and padding.
-    #
-    # +reserved_width_left+, +reserved_width_right+, +reserved_height_top+,
-    # +reserved_height_bottom+::
-    #     Returns the reserved space inside the box at the specified edge (left, right, top,
-    #     bottom).
-    #
-    # +update_content_width+, +update_content_height+::
-    #     Takes a block that should return the content width respectively height and sets the box's
-    #     width respectively height accordingly.
-    #
-    # +create_split_box+::
-    #     Creates a new box based on this one and resets the internal data back to their original
-    #     values.
+    # This base class also provides various protected helper methods for use in the above methods:
     #
-    #     The keyword argument +split_box_value+ (defaults to +true+) is used to set the
-    #     +@split_box+ variable to make the new box aware that it is a split box. This can be set to
-    #     any other truthy value to convey more meaning.
+    # * #reserved_width, #reserved_height
+    # * #reserved_width_left, #reserved_width_right, #reserved_height_top,
+    #   #reserved_height_bottom
+    # * #update_content_width, #update_content_height
+    # * #create_split_box
     class Box
 
       include HexaPDF::Utils
@@ -323,10 +312,12 @@ module HexaPDF
       # current region of the frame, adjusted for this box. The frame itself is provided as third
       # argument.
       #
-      # The default implementation uses the given available width and height for the box width and
-      # height if they were initially set to 0. Otherwise the intially specified dimensions are
-      # used. The method returns early if the thus configured box already doesn't fit. Otherwise,
-      # the #fit_content method is called which allows sub-classes to fit their content.
+      # If the box uses flow positioning, the width is set to the frame's width and the height to
+      # the remaining height in the frame. Otherwise the given available width and height are used
+      # for the width and height if they were initially set to 0. Otherwise the intially specified
+      # dimensions are used. The method returns early if the thus configured box already doesn't
+      # fit. Otherwise, the #fit_content method is called which allows sub-classes to fit their
+      # content.
       #
       # The following variables are set that may later be used during splitting or drawing:
       #
@@ -334,10 +325,25 @@ module HexaPDF
       #   used to adjust the drawing position in #draw_content if necessary.
       def fit(available_width, available_height, frame)
         @fit_result.reset(frame)
-        @width = (@initial_width > 0 ? @initial_width : available_width)
-        @height = (@initial_height > 0 ? @initial_height : available_height)
-        return @fit_result if style.position != :flow && (float_compare(@width, available_width) > 0 ||
-                                                          float_compare(@height, available_height) > 0)
+        position_flow = supports_position_flow? && style.position == :flow
+        @width = if @initial_width > 0
+                   @initial_width
+                 elsif position_flow
+                   frame.width
+                 else
+                   available_width
+                 end
+        @height = if @initial_height > 0
+                    @initial_height
+                  elsif position_flow
+                    frame.y - frame.bottom
+                  else
+                    available_height
+                  end
+        return @fit_result if !position_flow && (float_compare(@width, available_width) > 0 ||
+                                                 float_compare(@height, available_height) > 0 ||
+                                                 @width - reserved_width < 0 ||
+                                                 @height - reserved_height < 0)
 
         fit_content(available_width, available_height, frame)
 
@@ -379,7 +385,7 @@ module HexaPDF
       # system is translated so that the origin is at the bottom left corner of the **content box**.
       #
       # Subclasses should not rely on the +@draw_block+ but implement the #draw_content method. The
-      # coordinates passed to it are also modified to represent the bottom left corner of the
+      # coordinates passed to it are also modified to represent the bottom-left corner of the
       # content box but the coordinate system is not translated.
       def draw(canvas, x, y)
         if @fit_result.overflow? && @initial_height > 0 && style.overflow == :error
@@ -417,7 +423,7 @@ module HexaPDF
           (style.overlays? && !style.overlays.none?))
       end
 
-      private
+      protected
 
       # Returns the width that is reserved by the padding and border style properties.
       def reserved_width
@@ -465,12 +471,18 @@ module HexaPDF
         result
       end
 
+      # :call-seq:
+      #   update_content_width { block }
+      #
       # Updates the width of the box using the content width returned by the block.
       def update_content_width
         return if @initial_width > 0
         @width = yield + reserved_width
       end
 
+      # :call-seq:
+      #   update_content_height { block }
+      #
       # Updates the height of the box using the content height returned by the block.
       def update_content_height
         return if @initial_height > 0
@@ -479,13 +491,12 @@ module HexaPDF
 
       # Fits the content of the box and returns whether fitting was successful.
       #
-      # This is just a stub implementation that sets the #fit_result status to success if the
-      # content rectangle is not degenerate. Subclasses should override it to provide the box
-      # specific behaviour.
+      # This is just a stub implementation that sets the #fit_result status to success. Subclasses
+      # should override it to provide the box specific behaviour.
       #
       # See #fit for details.
       def fit_content(_available_width, _available_height, _frame)
-        fit_result.success! if content_width > 0 && content_height > 0
+        fit_result.success!
       end
 
       # Splits the content of the box.
@@ -510,7 +521,8 @@ module HexaPDF
         end
       end
 
-      # Creates a new box based on this one and resets the data back to their original values.
+      # Creates a new box based on this one and resets the internal data back to their original
+      # values.
       #
       # The variable +@split_box+ is set to +split_box_value+ (defaults to +true+) to make the new
       # box aware that it is a split box. If needed, subclasses can set the variable to other truthy

data/lib/hexapdf/layout/column_box.rb

@@ -142,19 +142,11 @@ module HexaPDF
 
       # Fits the column box into the current region of the frame.
       #
-      def fit_content(available_width, available_height, frame)
+      def fit_content(_available_width, _available_height, frame)
         initial_fit_successful = (@equal_height && @columns.size > 1 ? nil : false)
         tries = 0
-        width = if style.position == :flow
-                  (@initial_width > 0 ? @initial_width : frame.width) - reserved_width
-                else
-                  (@initial_width > 0 ? @initial_width : available_width) - reserved_width
-                end
-        height = if style.position == :flow
-                   (@initial_height > 0 ? @initial_height : frame.y - frame.bottom) - reserved_height
-                 else
-                   (@initial_height > 0 ? @initial_height : available_height) - reserved_height
-                 end
+        width = @width - reserved_width
+        height = @height - reserved_height
 
         columns = calculate_columns(width)
         return if columns.empty?

data/lib/hexapdf/layout/container_box.rb

@@ -52,7 +52,7 @@ module HexaPDF
     # setting the style properties 'mask_mode', 'align' and 'valign', it is possible to lay out the
     # children bottom to top, left to right, or right to left:
     #
-    # * The standard top to bottom layout:
+    # * The standard top-to-bottom layout:
     #
     #     #>pdf-composer100
     #     composer.container do |container|
@@ -61,7 +61,7 @@ module HexaPDF
     #       container.box(:base, height: 20, style: {background_color: "hp-blue-light"})
     #     end
     #
-    # * The bottom to top layout (using valign = :bottom to fill up from the bottom and mask_mode =
+    # * The bottom-to-top layout (using valign = :bottom to fill up from the bottom and mask_mode =
     #   :fill_horizontal to only remove the area to the left and right of the box):
     #
     #     #>pdf-composer100
@@ -74,7 +74,7 @@ module HexaPDF
     #                                                mask_mode: :fill_horizontal, valign: :bottom})
     #     end
     #
-    # * The left to right layout (using mask_mode = :fill_vertical to fill the area to the top and
+    # * The left-to-right layout (using mask_mode = :fill_vertical to fill the area to the top and
     #   bottom of the box):
     #
     #     #>pdf-composer100
@@ -87,7 +87,7 @@ module HexaPDF
     #                                               mask_mode: :fill_vertical})
     #     end
     #
-    # * The right to left layout (using align = :right to fill up from the right and mask_mode =
+    # * The right-to-left layout (using align = :right to fill up from the right and mask_mode =
     #   :fill_vertical to fill the area to the top and bottom of the box):
     #
     #     #>pdf-composer100

data/lib/hexapdf/layout/frame.rb

@@ -54,7 +54,7 @@ module HexaPDF
     #
     #   The method #fit is also called for absolutely positioned boxes but since these boxes are not
     #   subject to the normal constraints, the provided available width and height are the width and
-    #   height inside the frame to the right and top of the bottom left corner of the box.
+    #   height inside the frame to the right and top of the bottom-left corner of the box.
     #
     # * If the box didn't fit, call #find_next_region to determine the next region for placing the
     #   box. If a new region was found, start over with #fit. Otherwise the frame has no more space
@@ -84,10 +84,10 @@ module HexaPDF
 
       include HexaPDF::Utils
 
-      # The x-coordinate of the bottom left corner.
+      # The x-coordinate of the bottom-left corner.
       attr_reader :left
 
-      # The y-coordinate of the bottom left corner.
+      # The y-coordinate of the bottom-left corner.
       attr_reader :bottom
 
       # The width of the frame.
@@ -127,7 +127,7 @@ module HexaPDF
 
       # An array of box objects representing the parent boxes.
       #
-      # The immediate parent is the last array entry, the top most parent the first one. All boxes
+      # The immediate parent is the last array entry, the top-most parent the first one. All boxes
       # that are fitted into this frame have to be child boxes of the immediate parent box.
       attr_reader :parent_boxes
 
@@ -216,6 +216,7 @@ module HexaPDF
           end
 
           fit_result = box.fit(aw, ah, self)
+          return fit_result if fit_result.failure?
 
           width = box.width
           height = box.height
@@ -251,7 +252,7 @@ module HexaPDF
                   end
                 end
           when :flow
-            x = 0
+            x = fit_result.x || left
             y = @y - height
           else
             raise HexaPDF::Error, "Invalid value '#{position}' for style property position"
@@ -382,7 +383,7 @@ module HexaPDF
       # Since not all text may start at the top of the frame, the offset argument can be used to
       # specify a vertical offset from the top of the frame where layouting should start.
       #
-      # To be compatible with TextLayouter, the top left corner of the bounding box of the frame's
+      # To be compatible with TextLayouter, the top-left corner of the bounding box of the frame's
       # shape is the origin of the coordinate system for the width specification, with positive
       # x-values to the right and positive y-values downwards.
       #