JezK
Edit File: define-i.ri
U:RDoc::AnyMethod[iI"define:EFI"Prawn::Outline#define;FF:publico:RDoc::Markup::Document:@parts[o:RDoc::Markup::Paragraph; [I"2Defines/Updates an outline for the document. ;TI"OThe outline is an optional nested index that appears on the side of a PDF ;TI"Wdocument usually with direct links to pages. The outline DSL is defined by nested ;TI"\blocks involving two methods: section and page; see the documentation on those methods ;TI"Pfor their arguments and options. Note that one can also use outline#update ;TI"Yto add more sections to the end of the outline tree using the same syntax and scope.;To:RDoc::Markup::BlankLine o; ; [I"4The syntax is best illustrated with an example:;T@o; ; [I"7Prawn::Document.generate(outlined_document.pdf) do;To:RDoc::Markup::Verbatim; [I"0text "Page 1. This is the first Chapter. " ;TI"start_new_page ;TI"0text "Page 2. More in the first Chapter. " ;TI"start_new_page ;TI"outline.define do ;TI"B section 'Chapter 1', :destination => 1, :closed => true do ;TI"4 page :destination => 1, :title => 'Page 1' ;TI"4 page :destination => 2, :title => 'Page 2' ;TI" end ;TI" end ;TI"start_new_page do ;TI"outline.update do ;TI"3 section 'Chapter 2', :destination => 2, do ;TI"4 page :destination => 3, :title => 'Page 3' ;TI" end ;TI" end ;T:@format0o; ; [I"end;T: @fileI"lib/prawn/outline.rb;T:0@omit_headings_from_table_of_contents_below000[[I"update;To;; [ ;@/;0I" (&block);T@/FI"Outline;FcRDoc::NormalClass00