Module: Idml

Defined in:
lib/idml.rb,
lib/idml/cli.rb,
lib/idml/part.rb,
lib/idml/parts.rb,
lib/idml/errors.rb,
lib/idml/render.rb,
lib/idml/package.rb,
lib/idml/version.rb,
lib/idml/document.rb,
lib/idml/elements.rb,
lib/idml/geometry.rb,
lib/idml/namespace.rb,
lib/idml/parts/raw.rb,
lib/idml/parts/tags.rb,
lib/idml/validation.rb,
lib/idml/composition.rb,
lib/idml/parts/fonts.rb,
lib/idml/parts/story.rb,
lib/idml/parts/style.rb,
lib/idml/text_engine.rb,
lib/idml/elements/ink.rb,
lib/idml/parts/spread.rb,
lib/idml/render/image.rb,
lib/idml/elements/font.rb,
lib/idml/elements/link.rb,
lib/idml/elements/page.rb,
lib/idml/elements/tint.rb,
lib/idml/parts/graphic.rb,
lib/idml/parts/mapping.rb,
lib/idml/elements/color.rb,
lib/idml/elements/group.rb,
lib/idml/elements/image.rb,
lib/idml/elements/layer.rb,
lib/idml/elements/table.rb,
lib/idml/elements/swatch.rb,
lib/idml/parts/designmap.rb,
lib/idml/render/pipeline.rb,
lib/idml/elements/content.rb,
lib/idml/elements/polygon.rb,
lib/idml/elements/xml_tag.rb,
lib/idml/render/renderers.rb,
lib/idml/elements/gradient.rb,
lib/idml/parts/preferences.rb,
lib/idml/validation/result.rb,
lib/idml/composition/prefix.rb,
lib/idml/elements/mixed_ink.rb,
lib/idml/elements/rectangle.rb,
lib/idml/elements/table_row.rb,
lib/idml/elements/toc_style.rb,
lib/idml/elements/xml_story.rb,
lib/idml/text_engine/shaper.rb,
lib/idml/elements/cell_style.rb,
lib/idml/elements/properties.rb,
lib/idml/elements/table_cell.rb,
lib/idml/elements/text_frame.rb,
lib/idml/parts/backing_story.rb,
lib/idml/parts/master_spread.rb,
lib/idml/parts/style_mapping.rb,
lib/idml/render/color_helper.rb,
lib/idml/render/layer_filter.rb,
lib/idml/render/pdfrb_writer.rb,
lib/idml/elements/font_family.rb,
lib/idml/elements/story_inner.rb,
lib/idml/elements/table_style.rb,
lib/idml/elements/trap_preset.rb,
lib/idml/elements/xml_element.rb,
lib/idml/validation/validator.rb,
lib/idml/elements/graphic_line.rb,
lib/idml/elements/object_style.rb,
lib/idml/elements/stroke_style.rb,
lib/idml/render/color_resolver.rb,
lib/idml/render/render_context.rb,
lib/idml/render/story_threader.rb,
lib/idml/render/style_resolver.rb,
lib/idml/text_engine/justifier.rb,
lib/idml/composition/export_xml.rb,
lib/idml/composition/import_xml.rb,
lib/idml/elements/gradient_stop.rb,
lib/idml/elements/path_geometry.rb,
lib/idml/elements/satin_setting.rb,
lib/idml/elements/spread_object.rb,
lib/idml/render/spread_renderer.rb,
lib/idml/text_engine/cjk_layout.rb,
lib/idml/composition/insert_idml.rb,
lib/idml/elements/contour_option.rb,
lib/idml/elements/xml_export_map.rb,
lib/idml/elements/xml_import_map.rb,
lib/idml/elements/character_style.rb,
lib/idml/elements/document_object.rb,
lib/idml/elements/feather_setting.rb,
lib/idml/elements/mixed_ink_group.rb,
lib/idml/elements/paragraph_style.rb,
lib/idml/elements/path_point_type.rb,
lib/idml/elements/pref_data_merge.rb,
lib/idml/elements/toc_style_entry.rb,
lib/idml/render/gradient_resolver.rb,
lib/idml/text_engine/font_metrics.rb,
lib/idml/text_engine/line_breaker.rb,
lib/idml/elements/blending_setting.rb,
lib/idml/elements/cell_style_group.rb,
lib/idml/elements/path_point_array.rb,
lib/idml/elements/story_preference.rb,
lib/idml/render/page_item_renderer.rb,
lib/idml/text_engine/font_resolver.rb,
lib/idml/elements/pref_text_default.rb,
lib/idml/elements/table_style_group.rb,
lib/idml/elements/geometry_path_type.rb,
lib/idml/elements/inner_glow_setting.rb,
lib/idml/elements/object_style_group.rb,
lib/idml/elements/outer_glow_setting.rb,
lib/idml/elements/pref_index_options.rb,
lib/idml/text_engine/vertical_layout.rb,
lib/idml/elements/dashed_stroke_style.rb,
lib/idml/elements/dotted_stroke_style.rb,
lib/idml/elements/drop_shadow_setting.rb,
lib/idml/elements/pasted_smooth_shade.rb,
lib/idml/elements/pref_xml_preference.rb,
lib/idml/elements/frame_fitting_option.rb,
lib/idml/elements/inner_shadow_setting.rb,
lib/idml/elements/master_spread_object.rb,
lib/idml/elements/object_export_option.rb,
lib/idml/elements/pref_footnote_option.rb,
lib/idml/elements/pref_grid_preference.rb,
lib/idml/elements/pref_text_preference.rb,
lib/idml/elements/pref_view_preference.rb,
lib/idml/elements/striped_stroke_style.rb,
lib/idml/elements/style_export_tag_map.rb,
lib/idml/elements/text_wrap_preference.rb,
lib/idml/elements/transparency_setting.rb,
lib/idml/composition/add_page_from_idml.rb,
lib/idml/elements/character_style_group.rb,
lib/idml/elements/character_style_range.rb,
lib/idml/elements/opacity_gradient_stop.rb,
lib/idml/elements/paragraph_style_group.rb,
lib/idml/elements/paragraph_style_range.rb,
lib/idml/elements/pref_data_merge_field.rb,
lib/idml/elements/pref_guide_preference.rb,
lib/idml/elements/pref_print_preference.rb,
lib/idml/elements/root_cell_style_group.rb,
lib/idml/elements/text_frame_preference.rb,
lib/idml/render/font_reference_resolver.rb,
lib/idml/elements/pref_button_preference.rb,
lib/idml/elements/pref_data_merge_option.rb,
lib/idml/elements/pref_margin_preference.rb,
lib/idml/elements/pref_page_item_default.rb,
lib/idml/elements/root_table_style_group.rb,
lib/idml/render/renderers/group_renderer.rb,
lib/idml/render/renderers/table_renderer.rb,
lib/idml/elements/anchored_object_setting.rb,
lib/idml/elements/root_object_style_group.rb,
lib/idml/elements/bevel_and_emboss_setting.rb,
lib/idml/elements/gradient_feather_setting.rb,
lib/idml/elements/pref_cjk_grid_preference.rb,
lib/idml/elements/pref_document_preference.rb,
lib/idml/render/renderers/polygon_renderer.rb,
lib/idml/elements/fill_transparency_setting.rb,
lib/idml/elements/pref_index_header_setting.rb,
lib/idml/elements/pref_print_booklet_option.rb,
lib/idml/elements/baseline_frame_grid_option.rb,
lib/idml/elements/pref_dictionary_preference.rb,
lib/idml/elements/pref_pasteboard_preference.rb,
lib/idml/elements/pref_xml_export_preference.rb,
lib/idml/elements/pref_xml_import_preference.rb,
lib/idml/elements/root_character_style_group.rb,
lib/idml/elements/root_paragraph_style_group.rb,
lib/idml/elements/transform_attribute_option.rb,
lib/idml/render/renderers/rectangle_renderer.rb,
lib/idml/elements/directional_feather_setting.rb,
lib/idml/elements/object_style_export_tag_map.rb,
lib/idml/elements/pref_html_export_preference.rb,
lib/idml/elements/pref_mojikumi_ui_preference.rb,
lib/idml/elements/stroke_transparency_setting.rb,
lib/idml/render/renderers/text_frame_renderer.rb,
lib/idml/elements/content_transparency_setting.rb,
lib/idml/elements/flex_layout_attribute_option.rb,
lib/idml/elements/pref_anchored_object_default.rb,
lib/idml/elements/pref_e_pub_export_preference.rb,
lib/idml/elements/pref_transparency_preference.rb,
lib/idml/elements/pref_tin_document_data_object.rb,
lib/idml/render/renderers/graphic_line_renderer.rb,
lib/idml/elements/pref_chapter_number_preference.rb,
lib/idml/elements/pref_export_for_web_preference.rb,
lib/idml/elements/pref_story_grid_data_information.rb,
lib/idml/elements/pref_layout_adjustment_preference.rb,
lib/idml/elements/pref_layout_grid_data_information.rb,
lib/idml/elements/text_frame_footnote_options_object.rb,
lib/idml/elements/pref_print_booklet_print_preference.rb,
lib/idml/elements/pref_e_pub_fixed_layout_export_preference.rb,
lib/idml/elements/pref_transparency_default_container_object.rb,
lib/idml/elements/object_style_fill_effects_category_settings.rb,
lib/idml/elements/object_style_object_effects_category_settings.rb,
lib/idml/elements/object_style_stroke_effects_category_settings.rb,
lib/idml/elements/object_style_content_effects_category_settings.rb

Defined Under Namespace

Modules: Composition, Elements, Errors, Geometry, Part, Parts, Render, TextEngine, Validation Classes: CLI, Document, Package, PackagingNamespace

Constant Summary collapse

VERSION = 
"0.2.1"

Class Method Summary collapse

Class Method Details

.document(package) ⇒ Object

Convenience: wrap a Package in a Document for cross-part queries.



30
31
32
 
# File 'lib/idml.rb', line 30

def self.document(package)
  Document.new(package)
end

.open(path) ⇒ Object

Convenience: open an IDML file. Equivalent to Package.new(path).



25
26
27
 
# File 'lib/idml.rb', line 25

def self.open(path)
  Package.new(path)
end