aspose_pdf_cloud 20.8.0 → 21.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Examples/delete_annotation.rb +22 -0
- data/Examples/delete_document_annotations.rb +18 -0
- data/Examples/delete_page_annotations.rb +17 -0
- data/Examples/example_data/PdfWithAnnotations.pdf +0 -0
- data/Examples/get_carret_annotation.rb +20 -0
- data/Examples/get_circle_annotation.rb +21 -0
- data/Examples/get_circle_annotations.rb +17 -0
- data/Examples/get_document_annotations.rb +15 -0
- data/Examples/get_document_free_text_annotations.rb +17 -0
- data/Examples/get_document_highlight_annotations.rb +16 -0
- data/Examples/get_document_ink_annotations.rb +15 -0
- data/Examples/get_document_line_annotations.rb +16 -0
- data/Examples/get_document_movie_annotations.rb +16 -0
- data/Examples/get_document_polygon_annotations.rb +16 -0
- data/Examples/get_document_polyline_annotations.rb +17 -0
- data/Examples/get_document_popup_annotation_by_parent.rb +17 -0
- data/Examples/get_document_popup_annotations.rb +16 -0
- data/Examples/get_document_redaction_annotations.rb +16 -0
- data/Examples/get_document_screen_annotations.rb +17 -0
- data/Examples/get_document_sound_annotations.rb +18 -0
- data/Examples/get_document_squiggly_annotations.rb +18 -0
- data/Examples/get_document_stamp_annotations.rb +17 -0
- data/Examples/get_document_strike_out_annotation.rb +17 -0
- data/Examples/get_document_text_annotations.rb +17 -0
- data/Examples/get_document_underline_annotations.rb +17 -0
- data/Examples/get_documnet_carret_annotation.rb +17 -0
- data/Examples/get_file_attachment_annotation.rb +21 -0
- data/Examples/get_file_attachment_annotation_data.rb +21 -0
- data/Examples/get_file_attachment_annotations.rb +19 -0
- data/Examples/get_free_text_annotation.rb +20 -0
- data/Examples/get_hightlight_annotations.rb +20 -0
- data/Examples/get_ink_annotation.rb +21 -0
- data/Examples/get_line_annotation.rb +20 -0
- data/Examples/get_movie_annotation.rb +20 -0
- data/Examples/get_page_annotations.rb +19 -0
- data/Examples/get_page_carret_annotations.rb +17 -0
- data/Examples/get_page_file_attachment_annotations.rb +19 -0
- data/Examples/get_page_free_text_annotations.rb +18 -0
- data/Examples/get_page_highlight_annotations.rb +18 -0
- data/Examples/get_page_ink_annotations.rb +17 -0
- data/Examples/get_page_line_annotations.rb +17 -0
- data/Examples/get_page_movie_annotations.rb +18 -0
- data/Examples/get_page_polygon_annotations.rb +18 -0
- data/Examples/get_page_polyline_annotations.rb +21 -0
- data/Examples/get_page_redaction_annotations.rb +17 -0
- data/Examples/get_page_screen_annotations.rb +19 -0
- data/Examples/get_page_sound_annotations.rb +20 -0
- data/Examples/get_page_square_annotations.rb +18 -0
- data/Examples/get_page_squiggly_annotations.rb +17 -0
- data/Examples/get_page_stamp_annotations.rb +17 -0
- data/Examples/get_page_strikeout_annotations.rb +17 -0
- data/Examples/get_page_text_annotations.rb +17 -0
- data/Examples/get_page_underline_annotations.rb +17 -0
- data/Examples/get_polygon_annotation.rb +20 -0
- data/Examples/get_polyline_annotation.rb +22 -0
- data/Examples/get_redaction_annotation.rb +19 -0
- data/Examples/get_screen_annotation.rb +22 -0
- data/Examples/get_screen_annotation_data.rb +19 -0
- data/Examples/get_screen_annotations.rb +21 -0
- data/Examples/get_sound_annotation.rb +25 -0
- data/Examples/get_sound_annotation_data.rb +19 -0
- data/Examples/get_square_annotation.rb +19 -0
- data/Examples/get_squiggly_annotation.rb +19 -0
- data/Examples/get_stamp_annotation.rb +20 -0
- data/Examples/get_stamp_annotation_data.rb +20 -0
- data/Examples/get_strike_out_annotation.rb +19 -0
- data/Examples/get_text_annotation.rb +19 -0
- data/Examples/get_underline_annotation.rb +19 -0
- data/Examples/post_page_carret_annotations.rb +28 -0
- data/Examples/post_page_circle_annotations.rb +27 -0
- data/Examples/post_page_file_attachnment_annotations.rb +38 -0
- data/Examples/post_page_free_text_annotations.rb +35 -0
- data/Examples/post_page_hightlight_annotations.rb +32 -0
- data/Examples/post_page_ink_annotations.rb +39 -0
- data/Examples/post_page_line_annotations.rb +28 -0
- data/Examples/post_page_movie_annotations.rb +30 -0
- data/Examples/post_page_polygon_annotations.rb +33 -0
- data/Examples/post_page_polyline_annotations.rb +35 -0
- data/Examples/post_page_redaction_annotations.rb +28 -0
- data/Examples/post_page_screen_annotations.rb +31 -0
- data/Examples/post_page_sound_annotations.rb +35 -0
- data/Examples/post_page_square_annotations.rb +27 -0
- data/Examples/post_page_squiggly_annotations.rb +33 -0
- data/Examples/post_page_stamp_annotations.rb +34 -0
- data/Examples/post_page_strike_out_annotation.rb +33 -0
- data/Examples/post_page_text_annotations.rb +26 -0
- data/Examples/post_page_underline_annotations.rb +33 -0
- data/Examples/post_popup_annotation.rb +25 -0
- data/Examples/put_annotations_flatten.rb +20 -0
- data/Examples/put_carret_annotation.rb +30 -0
- data/Examples/put_circle_annotation.rb +29 -0
- data/Examples/put_file_attachment_annotation.rb +38 -0
- data/Examples/put_file_attachment_annotion_data_extract.rb +21 -0
- data/Examples/put_free_text_annotation.rb +38 -0
- data/Examples/put_highlight_annotation.rb +34 -0
- data/Examples/put_ink_annotation.rb +41 -0
- data/Examples/put_line_annotation.rb +30 -0
- data/Examples/put_movie_annotation.rb +31 -0
- data/Examples/put_polygon_annotation.rb +35 -0
- data/Examples/put_polyline_annotation.rb +36 -0
- data/Examples/put_redaction_annotation.rb +31 -0
- data/Examples/put_screen_annotation.rb +33 -0
- data/Examples/put_screen_annotation_data_extract.rb +19 -0
- data/Examples/put_sound_annotation.rb +42 -0
- data/Examples/put_sound_annotation_data_extract.rb +20 -0
- data/Examples/put_square_annotation.rb +28 -0
- data/Examples/put_squiggly_annotation.rb +35 -0
- data/Examples/put_stamp_annotation.rb +35 -0
- data/Examples/put_strike_out_annotation.rb +35 -0
- data/Examples/put_text_annotation.rb +29 -0
- data/Examples/put_underline_annotation.rb +35 -0
- data/LICENSE +1 -1
- data/README.md +65 -53
- data/aspose_pdf_cloud.gemspec +53 -53
- data/docs/PdfApi.md +8 -102
- data/docs/RedactionAnnotation.md +1 -1
- data/docs/SignatureCustomAppearance.md +1 -1
- data/docs/TextReplace.md +1 -1
- data/docs/TextStyle.md +1 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +29142 -29421
- data/lib/aspose_pdf_cloud/api_client.rb +1 -1
- data/lib/aspose_pdf_cloud/api_error.rb +47 -47
- data/lib/aspose_pdf_cloud/configuration.rb +172 -172
- data/lib/aspose_pdf_cloud/models/annotation.rb +318 -318
- data/lib/aspose_pdf_cloud/models/annotation_flags.rb +53 -53
- data/lib/aspose_pdf_cloud/models/annotation_info.rb +333 -333
- data/lib/aspose_pdf_cloud/models/annotation_state.rb +50 -50
- data/lib/aspose_pdf_cloud/models/annotation_type.rb +70 -70
- data/lib/aspose_pdf_cloud/models/annotations_info.rb +213 -213
- data/lib/aspose_pdf_cloud/models/annotations_info_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/antialiasing_processing_type.rb +44 -44
- data/lib/aspose_pdf_cloud/models/aspose_response.rb +214 -214
- data/lib/aspose_pdf_cloud/models/attachment.rb +276 -276
- data/lib/aspose_pdf_cloud/models/attachment_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/attachments.rb +213 -213
- data/lib/aspose_pdf_cloud/models/attachments_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/bookmark.rb +361 -361
- data/lib/aspose_pdf_cloud/models/bookmark_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/bookmarks.rb +213 -213
- data/lib/aspose_pdf_cloud/models/bookmarks_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/border.rb +249 -249
- data/lib/aspose_pdf_cloud/models/border_corner_style.rb +44 -44
- data/lib/aspose_pdf_cloud/models/border_effect.rb +44 -44
- data/lib/aspose_pdf_cloud/models/border_info.rb +239 -239
- data/lib/aspose_pdf_cloud/models/border_style.rb +47 -47
- data/lib/aspose_pdf_cloud/models/box_style.rb +48 -48
- data/lib/aspose_pdf_cloud/models/cap_style.rb +44 -44
- data/lib/aspose_pdf_cloud/models/caption_position.rb +44 -44
- data/lib/aspose_pdf_cloud/models/caret_annotation.rb +378 -378
- data/lib/aspose_pdf_cloud/models/caret_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/caret_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/caret_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/caret_symbol.rb +44 -44
- data/lib/aspose_pdf_cloud/models/cell.rb +353 -353
- data/lib/aspose_pdf_cloud/models/cell_recognized.rb +209 -209
- data/lib/aspose_pdf_cloud/models/check_box_field.rb +455 -455
- data/lib/aspose_pdf_cloud/models/check_box_field_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/check_box_fields.rb +213 -213
- data/lib/aspose_pdf_cloud/models/check_box_fields_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/choice_field.rb +418 -418
- data/lib/aspose_pdf_cloud/models/circle_annotation.rb +378 -378
- data/lib/aspose_pdf_cloud/models/circle_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/circle_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/circle_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/color.rb +249 -249
- data/lib/aspose_pdf_cloud/models/color_depth.rb +46 -46
- data/lib/aspose_pdf_cloud/models/column_adjustment.rb +45 -45
- data/lib/aspose_pdf_cloud/models/combo_box_field.rb +460 -460
- data/lib/aspose_pdf_cloud/models/combo_box_field_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/combo_box_fields.rb +213 -213
- data/lib/aspose_pdf_cloud/models/combo_box_fields_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/common_figure_annotation.rb +378 -378
- data/lib/aspose_pdf_cloud/models/compression_type.rb +47 -47
- data/lib/aspose_pdf_cloud/models/crypto_algorithm.rb +46 -46
- data/lib/aspose_pdf_cloud/models/dash.rb +219 -219
- data/lib/aspose_pdf_cloud/models/default_page_config.rb +209 -209
- data/lib/aspose_pdf_cloud/models/direction.rb +44 -44
- data/lib/aspose_pdf_cloud/models/disc_usage.rb +219 -219
- data/lib/aspose_pdf_cloud/models/display_properties.rb +291 -291
- data/lib/aspose_pdf_cloud/models/display_properties_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/doc_format.rb +44 -44
- data/lib/aspose_pdf_cloud/models/doc_mdp_access_permission_type.rb +45 -45
- data/lib/aspose_pdf_cloud/models/doc_recognition_mode.rb +44 -44
- data/lib/aspose_pdf_cloud/models/document.rb +231 -231
- data/lib/aspose_pdf_cloud/models/document_config.rb +234 -234
- data/lib/aspose_pdf_cloud/models/document_page_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/document_pages_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/document_privilege.rb +299 -299
- data/lib/aspose_pdf_cloud/models/document_properties.rb +213 -213
- data/lib/aspose_pdf_cloud/models/document_properties_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/document_property.rb +236 -236
- data/lib/aspose_pdf_cloud/models/document_property_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/document_response.rb +236 -236
- data/lib/aspose_pdf_cloud/models/epub_recognition_mode.rb +45 -45
- data/lib/aspose_pdf_cloud/models/error.rb +229 -229
- data/lib/aspose_pdf_cloud/models/error_details.rb +214 -214
- data/lib/aspose_pdf_cloud/models/field.rb +260 -260
- data/lib/aspose_pdf_cloud/models/field_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/field_type.rb +46 -46
- data/lib/aspose_pdf_cloud/models/fields.rb +218 -218
- data/lib/aspose_pdf_cloud/models/fields_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/file_attachment_annotation.rb +408 -408
- data/lib/aspose_pdf_cloud/models/file_attachment_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/file_attachment_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/file_attachment_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/file_icon.rb +46 -46
- data/lib/aspose_pdf_cloud/models/file_version.rb +274 -274
- data/lib/aspose_pdf_cloud/models/file_versions.rb +201 -201
- data/lib/aspose_pdf_cloud/models/files_list.rb +201 -201
- data/lib/aspose_pdf_cloud/models/files_upload_result.rb +213 -213
- data/lib/aspose_pdf_cloud/models/font_encoding_rules.rb +44 -44
- data/lib/aspose_pdf_cloud/models/font_saving_modes.rb +46 -46
- data/lib/aspose_pdf_cloud/models/font_styles.rb +46 -46
- data/lib/aspose_pdf_cloud/models/form_field.rb +398 -398
- data/lib/aspose_pdf_cloud/models/free_text_annotation.rb +403 -403
- data/lib/aspose_pdf_cloud/models/free_text_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/free_text_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/free_text_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/free_text_intent.rb +45 -45
- data/lib/aspose_pdf_cloud/models/graph_info.rb +301 -301
- data/lib/aspose_pdf_cloud/models/highlight_annotation.rb +370 -370
- data/lib/aspose_pdf_cloud/models/highlight_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/highlight_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/highlight_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/horizontal_alignment.rb +46 -46
- data/lib/aspose_pdf_cloud/models/html_document_type.rb +44 -44
- data/lib/aspose_pdf_cloud/models/html_markup_generation_modes.rb +44 -44
- data/lib/aspose_pdf_cloud/models/image.rb +266 -266
- data/lib/aspose_pdf_cloud/models/image_compression_version.rb +45 -45
- data/lib/aspose_pdf_cloud/models/image_encoding.rb +46 -46
- data/lib/aspose_pdf_cloud/models/image_footer.rb +341 -341
- data/lib/aspose_pdf_cloud/models/image_fragment.rb +283 -283
- data/lib/aspose_pdf_cloud/models/image_header.rb +341 -341
- data/lib/aspose_pdf_cloud/models/image_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/image_src_type.rb +44 -44
- data/lib/aspose_pdf_cloud/models/image_stamp.rb +361 -361
- data/lib/aspose_pdf_cloud/models/image_template.rb +301 -301
- data/lib/aspose_pdf_cloud/models/image_templates_request.rb +231 -231
- data/lib/aspose_pdf_cloud/models/images.rb +213 -213
- data/lib/aspose_pdf_cloud/models/images_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/ink_annotation.rb +380 -380
- data/lib/aspose_pdf_cloud/models/ink_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/ink_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/ink_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/justification.rb +45 -45
- data/lib/aspose_pdf_cloud/models/letters_positioning_methods.rb +44 -44
- data/lib/aspose_pdf_cloud/models/line_annotation.rb +488 -488
- data/lib/aspose_pdf_cloud/models/line_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/line_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/line_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/line_ending.rb +52 -52
- data/lib/aspose_pdf_cloud/models/line_intent.rb +45 -45
- data/lib/aspose_pdf_cloud/models/line_spacing.rb +44 -44
- data/lib/aspose_pdf_cloud/models/link.rb +229 -229
- data/lib/aspose_pdf_cloud/models/link_action_type.rb +48 -48
- data/lib/aspose_pdf_cloud/models/link_annotation.rb +294 -294
- data/lib/aspose_pdf_cloud/models/link_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/link_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/link_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/link_element.rb +201 -201
- data/lib/aspose_pdf_cloud/models/link_highlighting_mode.rb +47 -47
- data/lib/aspose_pdf_cloud/models/list_box_field.rb +462 -462
- data/lib/aspose_pdf_cloud/models/list_box_field_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/list_box_fields.rb +213 -213
- data/lib/aspose_pdf_cloud/models/list_box_fields_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/margin_info.rb +229 -229
- data/lib/aspose_pdf_cloud/models/markup_annotation.rb +358 -358
- data/lib/aspose_pdf_cloud/models/merge_documents.rb +206 -206
- data/lib/aspose_pdf_cloud/models/movie_annotation.rb +348 -348
- data/lib/aspose_pdf_cloud/models/movie_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/movie_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/movie_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/object_exist.rb +219 -219
- data/lib/aspose_pdf_cloud/models/optimize_options.rb +319 -319
- data/lib/aspose_pdf_cloud/models/option.rb +229 -229
- data/lib/aspose_pdf_cloud/models/output_format.rb +44 -44
- data/lib/aspose_pdf_cloud/models/page.rb +236 -236
- data/lib/aspose_pdf_cloud/models/page_layout.rb +49 -49
- data/lib/aspose_pdf_cloud/models/page_mode.rb +48 -48
- data/lib/aspose_pdf_cloud/models/page_number_stamp.rb +351 -351
- data/lib/aspose_pdf_cloud/models/page_word_count.rb +219 -219
- data/lib/aspose_pdf_cloud/models/pages.rb +213 -213
- data/lib/aspose_pdf_cloud/models/paragraph.rb +316 -316
- data/lib/aspose_pdf_cloud/models/parts_embedding_modes.rb +45 -45
- data/lib/aspose_pdf_cloud/models/pdf_a_type.rb +45 -45
- data/lib/aspose_pdf_cloud/models/pdf_page_stamp.rb +351 -351
- data/lib/aspose_pdf_cloud/models/permissions_flags.rb +50 -50
- data/lib/aspose_pdf_cloud/models/point.rb +219 -219
- data/lib/aspose_pdf_cloud/models/poly_annotation.rb +415 -415
- data/lib/aspose_pdf_cloud/models/poly_intent.rb +46 -46
- data/lib/aspose_pdf_cloud/models/poly_line_annotation.rb +415 -415
- data/lib/aspose_pdf_cloud/models/poly_line_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/poly_line_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/poly_line_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/polygon_annotation.rb +415 -415
- data/lib/aspose_pdf_cloud/models/polygon_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/polygon_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/polygon_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/popup_annotation.rb +328 -328
- data/lib/aspose_pdf_cloud/models/popup_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/popup_annotation_with_parent.rb +338 -338
- data/lib/aspose_pdf_cloud/models/popup_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/popup_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/position.rb +219 -219
- data/lib/aspose_pdf_cloud/models/radio_button_field.rb +452 -452
- data/lib/aspose_pdf_cloud/models/radio_button_field_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/radio_button_fields.rb +213 -213
- data/lib/aspose_pdf_cloud/models/radio_button_fields_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/radio_button_option_field.rb +418 -418
- data/lib/aspose_pdf_cloud/models/raster_images_saving_modes.rb +45 -45
- data/lib/aspose_pdf_cloud/models/rectangle.rb +249 -249
- data/lib/aspose_pdf_cloud/models/redaction_annotation.rb +380 -380
- data/lib/aspose_pdf_cloud/models/redaction_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/redaction_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/redaction_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/rotation.rb +46 -46
- data/lib/aspose_pdf_cloud/models/row.rb +306 -306
- data/lib/aspose_pdf_cloud/models/row_recognized.rb +211 -211
- data/lib/aspose_pdf_cloud/models/screen_annotation.rb +338 -338
- data/lib/aspose_pdf_cloud/models/screen_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/screen_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/screen_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/segment.rb +233 -233
- data/lib/aspose_pdf_cloud/models/shape_type.rb +45 -45
- data/lib/aspose_pdf_cloud/models/signature.rb +388 -388
- data/lib/aspose_pdf_cloud/models/signature_custom_appearance.rb +329 -329
- data/lib/aspose_pdf_cloud/models/signature_field.rb +408 -408
- data/lib/aspose_pdf_cloud/models/signature_field_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/signature_fields.rb +213 -213
- data/lib/aspose_pdf_cloud/models/signature_fields_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/signature_type.rb +45 -45
- data/lib/aspose_pdf_cloud/models/signature_verify_response.rb +229 -229
- data/lib/aspose_pdf_cloud/models/sound_annotation.rb +442 -442
- data/lib/aspose_pdf_cloud/models/sound_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/sound_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/sound_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/sound_encoding.rb +46 -46
- data/lib/aspose_pdf_cloud/models/sound_icon.rb +44 -44
- data/lib/aspose_pdf_cloud/models/split_result.rb +201 -201
- data/lib/aspose_pdf_cloud/models/split_result_document.rb +244 -244
- data/lib/aspose_pdf_cloud/models/split_result_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/square_annotation.rb +378 -378
- data/lib/aspose_pdf_cloud/models/square_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/square_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/square_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/squiggly_annotation.rb +370 -370
- data/lib/aspose_pdf_cloud/models/squiggly_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/squiggly_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/squiggly_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/stamp.rb +414 -414
- data/lib/aspose_pdf_cloud/models/stamp_annotation.rb +388 -388
- data/lib/aspose_pdf_cloud/models/stamp_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/stamp_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/stamp_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/stamp_base.rb +281 -281
- data/lib/aspose_pdf_cloud/models/stamp_icon.rb +56 -56
- data/lib/aspose_pdf_cloud/models/stamp_info.rb +276 -276
- data/lib/aspose_pdf_cloud/models/stamp_type.rb +46 -46
- data/lib/aspose_pdf_cloud/models/stamps_info.rb +213 -213
- data/lib/aspose_pdf_cloud/models/stamps_info_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/storage_exist.rb +204 -204
- data/lib/aspose_pdf_cloud/models/storage_file.rb +249 -249
- data/lib/aspose_pdf_cloud/models/strike_out_annotation.rb +370 -370
- data/lib/aspose_pdf_cloud/models/strike_out_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/strike_out_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/strike_out_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/table.rb +438 -438
- data/lib/aspose_pdf_cloud/models/table_broken.rb +45 -45
- data/lib/aspose_pdf_cloud/models/table_recognized.rb +243 -243
- data/lib/aspose_pdf_cloud/models/table_recognized_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/tables_recognized.rb +213 -213
- data/lib/aspose_pdf_cloud/models/tables_recognized_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/text_annotation.rb +388 -388
- data/lib/aspose_pdf_cloud/models/text_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/text_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/text_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/text_box_field.rb +458 -458
- data/lib/aspose_pdf_cloud/models/text_box_field_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/text_box_fields.rb +213 -213
- data/lib/aspose_pdf_cloud/models/text_box_fields_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/text_footer.rb +341 -341
- data/lib/aspose_pdf_cloud/models/text_header.rb +341 -341
- data/lib/aspose_pdf_cloud/models/text_horizontal_alignment.rb +48 -48
- data/lib/aspose_pdf_cloud/models/text_icon.rb +53 -53
- data/lib/aspose_pdf_cloud/models/text_line.rb +216 -216
- data/lib/aspose_pdf_cloud/models/text_rect.rb +269 -269
- data/lib/aspose_pdf_cloud/models/text_rects.rb +201 -201
- data/lib/aspose_pdf_cloud/models/text_rects_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/text_replace.rb +268 -292
- data/lib/aspose_pdf_cloud/models/text_replace_list_request.rb +236 -236
- data/lib/aspose_pdf_cloud/models/text_replace_response.rb +229 -229
- data/lib/aspose_pdf_cloud/models/text_stamp.rb +361 -361
- data/lib/aspose_pdf_cloud/models/text_state.rb +259 -259
- data/lib/aspose_pdf_cloud/models/text_style.rb +244 -234
- data/lib/aspose_pdf_cloud/models/timestamp_settings.rb +209 -209
- data/lib/aspose_pdf_cloud/models/underline_annotation.rb +370 -370
- data/lib/aspose_pdf_cloud/models/underline_annotation_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/underline_annotations.rb +213 -213
- data/lib/aspose_pdf_cloud/models/underline_annotations_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/vertical_alignment.rb +46 -46
- data/lib/aspose_pdf_cloud/models/word_count.rb +200 -200
- data/lib/aspose_pdf_cloud/models/word_count_response.rb +224 -224
- data/lib/aspose_pdf_cloud/models/wrap_mode.rb +45 -45
- data/lib/aspose_pdf_cloud/version.rb +24 -24
- data/lib/aspose_pdf_cloud.rb +325 -326
- data/test/pdf_tests.rb +1 -1
- data/test_data/FormDataXfdf_in.xfdf +21 -21
- data/test_data/TexExample.tex +304 -304
- data/test_data/sample.tex +105 -105
- metadata +143 -22
- data/docs/ApiInfo.md +0 -10
- data/lib/aspose_pdf_cloud/models/api_info.rb +0 -209
data/test/pdf_tests.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
=begin
|
2
2
|
--------------------------------------------------------------------------------------------------------------------
|
3
|
-
|
3
|
+
Copyright (c) 2021 Aspose.PDF Cloud
|
4
4
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
5
5
|
of this software and associated documentation files (the "Software"), to deal
|
6
6
|
in the Software without restriction, including without limitation the rights
|
@@ -1,21 +1,21 @@
|
|
1
|
-
<?xml version="1.0" encoding="utf-8"?>
|
2
|
-
<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">
|
3
|
-
<f href="test.pdf"/>
|
4
|
-
<fields>
|
5
|
-
<field name="Country">
|
6
|
-
<value>Deutschland</value>
|
7
|
-
</field>
|
8
|
-
<field name="State">
|
9
|
-
<value>Freie & Hansestadt Hamburg</value>
|
10
|
-
</field>
|
11
|
-
<field name="City">
|
12
|
-
<value>Hamburger</value>
|
13
|
-
</field>
|
14
|
-
<field name="Email">
|
15
|
-
<value>dirk.pass@bs-card-service.com</value>
|
16
|
-
</field>
|
17
|
-
<field name="FullName">
|
18
|
-
<value>Dirk Pass</value>
|
19
|
-
</field>
|
20
|
-
</fields>
|
21
|
-
</xfdf>
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
2
|
+
<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">
|
3
|
+
<f href="test.pdf"/>
|
4
|
+
<fields>
|
5
|
+
<field name="Country">
|
6
|
+
<value>Deutschland</value>
|
7
|
+
</field>
|
8
|
+
<field name="State">
|
9
|
+
<value>Freie & Hansestadt Hamburg</value>
|
10
|
+
</field>
|
11
|
+
<field name="City">
|
12
|
+
<value>Hamburger</value>
|
13
|
+
</field>
|
14
|
+
<field name="Email">
|
15
|
+
<value>dirk.pass@bs-card-service.com</value>
|
16
|
+
</field>
|
17
|
+
<field name="FullName">
|
18
|
+
<value>Dirk Pass</value>
|
19
|
+
</field>
|
20
|
+
</fields>
|
21
|
+
</xfdf>
|
data/test_data/TexExample.tex
CHANGED
@@ -1,305 +1,305 @@
|
|
1
|
-
%% Introduction to latex facilities.
|
2
|
-
%% Sat 31 Dec 2005
|
3
|
-
%% Stephen Eglen.
|
4
|
-
|
5
|
-
%% Text following a percent sign (%) until the end of line is treated
|
6
|
-
%% as a comment.
|
7
|
-
|
8
|
-
\documentclass{article}
|
9
|
-
|
10
|
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
11
|
-
%% This section is called the preamble, where we can specify which
|
12
|
-
%% latex packages we required. Most (but not of all) of the packages
|
13
|
-
%% below should be fairly standard in most latex documents. The
|
14
|
-
%% exception is xspace and the new \latex command, which you probably
|
15
|
-
%% do not need.
|
16
|
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
17
|
-
|
18
|
-
%% Better math support:
|
19
|
-
\usepackage{amsmath}
|
20
|
-
|
21
|
-
%% Bibliography style:
|
22
|
-
\usepackage{mathptmx} % Use the Times font.
|
23
|
-
\usepackage{graphicx} % Needed for including graphics.
|
24
|
-
\usepackage{url} % Facility for activating URLs.
|
25
|
-
|
26
|
-
%% Set the paper size to be A4, with a 2cm margin
|
27
|
-
%% all around the page.
|
28
|
-
\usepackage[a4paper,margin=2cm]{geometry}
|
29
|
-
|
30
|
-
%% Natbib is a popular style for formatting references.
|
31
|
-
\usepackage{natbib}
|
32
|
-
%% bibpunct sets the punctuation used for formatting citations.
|
33
|
-
\bibpunct{(}{)}{;}{a}{,}{,}
|
34
|
-
|
35
|
-
%% textcomp provides extra control sequences for accessing text symbols:
|
36
|
-
\usepackage{textcomp}
|
37
|
-
\newcommand*{\micro}{\textmu}
|
38
|
-
%% Here, we define the \micro command to print a text "mu".
|
39
|
-
%% "\newcommand" returns an error if "\micro" is already defined.
|
40
|
-
|
41
|
-
%% This is an example of a new macro that I've created to save me
|
42
|
-
%% having to type \LaTeX each time. The xspace command provides space
|
43
|
-
%% after the word LaTeX where appropriate.
|
44
|
-
\usepackage{xspace}
|
45
|
-
\providecommand*{\latex}{\LaTeX\xspace}
|
46
|
-
%% "\providecommand" does nothing if "\latex" is already defined.
|
47
|
-
|
48
|
-
|
49
|
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
50
|
-
%% Start of the document.
|
51
|
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
52
|
-
|
53
|
-
\begin{document}
|
54
|
-
|
55
|
-
\author{Stephen J. Eglen\\
|
56
|
-
Department of Applied Mathematics and Theoretical Physics\\
|
57
|
-
University of Cambridge\\
|
58
|
-
Wilberforce Road\\
|
59
|
-
Cambridge CB3 0WA U.K.}
|
60
|
-
\date{\today}
|
61
|
-
\title{A short example of how to use \latex for scientific reports}
|
62
|
-
\maketitle
|
63
|
-
|
64
|
-
\begin{abstract}
|
65
|
-
The purpose of this short document is to provide a brief overview of
|
66
|
-
the facilities that \latex offers for formatting scientific reports.
|
67
|
-
Furthermore, the source files for regenerating this report are
|
68
|
-
freely available so that users can easily start writing their own
|
69
|
-
reports using \latex.
|
70
|
-
\end{abstract}
|
71
|
-
|
72
|
-
\section{Introduction}
|
73
|
-
|
74
|
-
\latex is a typesetting program; given an input file with formatting
|
75
|
-
instructions (e.g intro.tex), the program will create your document in
|
76
|
-
one of several formats (DVI, Postscript or PDF). It is therefore not
|
77
|
-
a WYSIWYG word processor. \latex is known as a logical markup
|
78
|
-
language, similar for example to HTML, so that you describe a piece of
|
79
|
-
text as a ``section heading'' rather than saying that it should be
|
80
|
-
formatted in a certain way. It has excellent facilities for
|
81
|
-
typesetting mathematics, and handles large documents (such as theses)
|
82
|
-
well. The aim of this document is not to provide an overview of
|
83
|
-
\latex, since many other guides have already been written (see
|
84
|
-
Section~\ref{sec:summary}). Instead, it has been written primarily to
|
85
|
-
provide simple workable examples that you can cut and paste to help
|
86
|
-
you get started with \latex. The examples have been selected to be
|
87
|
-
those most likely to be useful when writing a scientific report. This
|
88
|
-
document is best read by comparing the source code with the resulting
|
89
|
-
output.
|
90
|
-
|
91
|
-
\section{Running \latex}
|
92
|
-
|
93
|
-
The files to accompany this paper are at:
|
94
|
-
\url{http://www.damtp.cam.ac.uk/user/eglen/texintro}. Get the
|
95
|
-
following files and put them into a new directory.
|
96
|
-
|
97
|
-
\begin{enumerate}
|
98
|
-
\item \url{intro.tex}: the main \latex document.
|
99
|
-
\item \url{example.bib}: a short bibliography.
|
100
|
-
\item \url{sigmoid.ps}: example postscript image.
|
101
|
-
\item \url{sigmoid.pdf}: example PDF image.
|
102
|
-
\end{enumerate}
|
103
|
-
|
104
|
-
Change directory to where you stored the files and type the
|
105
|
-
following (ignoring comments placed after \#\#):
|
106
|
-
|
107
|
-
\begin{verbatim}
|
108
|
-
latex intro ## Run latex 1st time.
|
109
|
-
bibtex intro ## Extract required references
|
110
|
-
latex intro ## Run latex 2nd to resolve references.
|
111
|
-
latex intro ## Probably need to run latex a 3rd time.
|
112
|
-
xdvi intro ## View the DVI (device independent) file.
|
113
|
-
dvips -o intro.ps intro ## Create a postscript file for printing.
|
114
|
-
\end{verbatim}
|
115
|
-
|
116
|
-
You will notice that you run latex several times here; this is so that
|
117
|
-
references can be resolved, and references can be extracted from your
|
118
|
-
bibtex file. After running latex, you will be told if you need to run
|
119
|
-
it again to resolve references. After a while, you will get the idea
|
120
|
-
of how many times you need to run latex to resolve all your
|
121
|
-
references.
|
122
|
-
|
123
|
-
If instead you would like to generate PDF files (see
|
124
|
-
Section~\ref{sec:graphics} for a discussion of file formats for
|
125
|
-
included images), you can try the following shorter sequence:
|
126
|
-
|
127
|
-
\begin{verbatim}
|
128
|
-
pdflatex intro
|
129
|
-
bibtex intro
|
130
|
-
pdflatex intro
|
131
|
-
pdflatex intro
|
132
|
-
xpdf intro.pdf ## View the resulting PDF
|
133
|
-
\end{verbatim}
|
134
|
-
|
135
|
-
Whether you prefer to generate DVI or PDF is up to you. The xdvi
|
136
|
-
viewer has some nice features, such as it can reload your document
|
137
|
-
easily and has a ``magnifying glass'' that is activated by the mouse.
|
138
|
-
On the other hand, xpdf will display the document more accurately as
|
139
|
-
it will be printed.
|
140
|
-
|
141
|
-
\section{Tables}
|
142
|
-
|
143
|
-
Tables are relatively straightforward to generate. Note that tables
|
144
|
-
and figures are not always placed exactly where you wish, as
|
145
|
-
they can \textit{float} to other parts of the document. Rather than
|
146
|
-
trying to battle with \latex as to where they are placed, concentrate
|
147
|
-
first on getting the right content and let \latex worry about the
|
148
|
-
positioning. Instead, use labels to your tables to refer to them.
|
149
|
-
See Table~\ref{tab:simple} and Table~\ref{tab:pars} for examples.
|
150
|
-
|
151
|
-
\begin{table}
|
152
|
-
\centering
|
153
|
-
\begin{tabular}{ccc}
|
154
|
-
year & min temp (\textdegree C) & max temp (\textdegree C)\\
|
155
|
-
\hline
|
156
|
-
1970 & $-5$ & 35\\
|
157
|
-
1975 & $-7$ & 29\\
|
158
|
-
1980 & $-3$ & 30\\
|
159
|
-
1985 & $-2$ & 32\\
|
160
|
-
\end{tabular}
|
161
|
-
\caption{Fictional minimal and maximal temperatures recorded in
|
162
|
-
Cambridge over several years.}
|
163
|
-
\label{tab:simple}
|
164
|
-
\end{table}
|
165
|
-
%% Why are the negative numbers above enclosed in math mode?
|
166
|
-
%% Hint: consider the difference between "-" in text and in math.
|
167
|
-
|
168
|
-
\begin{table}[htbp]
|
169
|
-
\centering
|
170
|
-
\begin{tabular}{lccc}\\ \hline
|
171
|
-
& \multicolumn{1}{c}{$\phi$ (\micro m)}
|
172
|
-
& \multicolumn{1}{c}{$\alpha$}
|
173
|
-
& $\delta_{12}$ (\micro m)\\ \hline
|
174
|
-
W81S1\\
|
175
|
-
$h_{11}(u)$ & 67.94 & 7.81\\
|
176
|
-
$h_{22}(u)$ & 66.27 & 5.40\\
|
177
|
-
$h_{12}(u)$ & & &18\\
|
178
|
-
\hline
|
179
|
-
M623\\
|
180
|
-
$h_{11}(u)$ &112.79 & 3.05\\
|
181
|
-
$h_{22}(u)$ & 65.46 & 8.11\\
|
182
|
-
$h_{12}(u)$ & & &20\\
|
183
|
-
\hline
|
184
|
-
\end{tabular}
|
185
|
-
\caption{Summary of parameter estimates for the univariate
|
186
|
-
functions $h_{11}(u)$, $h_{22}(u)$ and the bivariate function
|
187
|
-
$h_{12}(u)$. For the univariate fits, $\alpha$ and $\phi$ are
|
188
|
-
least-square estimates (assuming $\delta$ was fixed at 15 \micro m).
|
189
|
-
The final column gives the
|
190
|
-
maximum likelihood estimate of $\delta_{12}$ assuming that the
|
191
|
-
interaction between types is simple inhibition.
|
192
|
-
\label{tab:pars}}
|
193
|
-
\end{table}
|
194
|
-
|
195
|
-
|
196
|
-
\section{Bibliography management}
|
197
|
-
|
198
|
-
Scientific reports normally require a section where your references
|
199
|
-
are listed. Bibtex is an excellent system for maintaining references,
|
200
|
-
especially for large documents. Each reference needs a unique key;
|
201
|
-
you can then refer to the reference in your \latex document by using
|
202
|
-
this key within a cite command.
|
203
|
-
|
204
|
-
Take care when formatting your references, especially when it comes to
|
205
|
-
writing authors names and the case of letters in journal titles. In
|
206
|
-
our examples, the files are found in \url{example.bib}. As an example
|
207
|
-
of a citation, see \citep{ihaka1996} or \citep{ihaka1996,venables1999}.
|
208
|
-
|
209
|
-
Bibtex is flexible enough to format your references in a wide number
|
210
|
-
of different styles to suit your needs. In this file I have used the
|
211
|
-
``natbib'' package, which is suitable for the natural sciences.
|
212
|
-
Depending on the type of cite command you get (and the package that
|
213
|
-
you use for citations), you can get different styles of citation. See
|
214
|
-
Table~\ref{tab:cite} for some examples.
|
215
|
-
|
216
|
-
\begin{table}
|
217
|
-
\centering
|
218
|
-
\begin{tabular}{ll}
|
219
|
-
\hline
|
220
|
-
command & result\\ \hline
|
221
|
-
\verb+\citep{ihaka1996}+ & \citep{ihaka1996}\\
|
222
|
-
\verb+\citet{ihaka1996}+ & \citet{ihaka1996}\\
|
223
|
-
\verb+\citep[see][p. 300]{ihaka1996}+ &
|
224
|
-
\citep[see][p. 300]{ihaka1996}
|
225
|
-
\\
|
226
|
-
\verb+\citeauthor{ihaka1996}+ & \citeauthor{ihaka1996}
|
227
|
-
\\
|
228
|
-
\verb+\citeyear{ihaka1996}+ & \citeyear{ihaka1996}
|
229
|
-
\\
|
230
|
-
\hline
|
231
|
-
\end{tabular}
|
232
|
-
\caption{Examples of different citation commands available in the
|
233
|
-
natbib package.}
|
234
|
-
\label{tab:cite}
|
235
|
-
\end{table}
|
236
|
-
|
237
|
-
|
238
|
-
\section{Graphics}
|
239
|
-
\label{sec:graphics}
|
240
|
-
|
241
|
-
\latex can include images in one of several format, depending on
|
242
|
-
whether you use latex (postscript format required) or pdflatex (either
|
243
|
-
jpeg, png or pdf required). Figures can be included either at their
|
244
|
-
natural size, or you can specify e.g. the figure width.
|
245
|
-
Figure~\ref{fig:example} shows an example image which intentionally
|
246
|
-
looks slightly different depending on whether you compile the document
|
247
|
-
with latex or pdflatex. Note that in this example the suffix of the
|
248
|
-
image file is not included so that this document compiles under both
|
249
|
-
latex and pdflatex.
|
250
|
-
|
251
|
-
\begin{figure}
|
252
|
-
\centering
|
253
|
-
\includegraphics[width=6cm]{sigmoid}
|
254
|
-
\caption{Example of a sigmoidal curve generated by the R programming
|
255
|
-
environment. The title above the curve indicates whether you have
|
256
|
-
included the postscript or the pdf version of the figure.}
|
257
|
-
\label{fig:example}
|
258
|
-
\end{figure}
|
259
|
-
|
260
|
-
\section{Mathematics}
|
261
|
-
|
262
|
-
\latex can format mathematics with ease, either in line, such as
|
263
|
-
$x \times y$, or on separate lines, such as:
|
264
|
-
\[ x^2 +y^2 = z^2 \]
|
265
|
-
|
266
|
-
If you are writing several lines of equations, you can use statements
|
267
|
-
like the following:
|
268
|
-
|
269
|
-
\begin{align}
|
270
|
-
b(t) & = s(t) - \int_{0}^{T} a(t') \cdot i(T-t') dt'
|
271
|
-
\\
|
272
|
-
a(t) & = \int_{0}^{T} b(t) \cdot e(T-t') dt' \label{eq:am}
|
273
|
-
\\
|
274
|
-
g(t) & = b(t) \ast e(t) \nonumber
|
275
|
-
\end{align}
|
276
|
-
|
277
|
-
By using labels on certain equations, we can refer to equations by
|
278
|
-
number, such as equation~(\ref{eq:am}).
|
279
|
-
|
280
|
-
\section{Summary}
|
281
|
-
\label{sec:summary}
|
282
|
-
This short guide should give you a flavour of what can be done with
|
283
|
-
\latex. It is by no means complete, or supposed to be
|
284
|
-
self-explanatory. It is, however, hopefully enough to get you
|
285
|
-
started! Try experimenting by editing the source file and then
|
286
|
-
recompiling this document. As mentioned earlier, there are many
|
287
|
-
guides for latex. Two that I can recommend are
|
288
|
-
\url{http://www.andy-roberts.net/misc/latex/index.html} and
|
289
|
-
`` The (Not So) Short Introduction to LaTeX2e''
|
290
|
-
(\url{http://ctan.tug.org/tex-archive/info/lshort/english/lshort.pdf}).
|
291
|
-
|
292
|
-
|
293
|
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
294
|
-
%% Finally we specify the format required for our references and the
|
295
|
-
%% name of the bibtex file where our references should be taken from.
|
296
|
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
297
|
-
|
298
|
-
\bibliographystyle{plainnat}
|
299
|
-
\bibliography{example}
|
300
|
-
|
301
|
-
\end{document}
|
302
|
-
|
303
|
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
304
|
-
%% The end.
|
1
|
+
%% Introduction to latex facilities.
|
2
|
+
%% Sat 31 Dec 2005
|
3
|
+
%% Stephen Eglen.
|
4
|
+
|
5
|
+
%% Text following a percent sign (%) until the end of line is treated
|
6
|
+
%% as a comment.
|
7
|
+
|
8
|
+
\documentclass{article}
|
9
|
+
|
10
|
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
11
|
+
%% This section is called the preamble, where we can specify which
|
12
|
+
%% latex packages we required. Most (but not of all) of the packages
|
13
|
+
%% below should be fairly standard in most latex documents. The
|
14
|
+
%% exception is xspace and the new \latex command, which you probably
|
15
|
+
%% do not need.
|
16
|
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
17
|
+
|
18
|
+
%% Better math support:
|
19
|
+
\usepackage{amsmath}
|
20
|
+
|
21
|
+
%% Bibliography style:
|
22
|
+
\usepackage{mathptmx} % Use the Times font.
|
23
|
+
\usepackage{graphicx} % Needed for including graphics.
|
24
|
+
\usepackage{url} % Facility for activating URLs.
|
25
|
+
|
26
|
+
%% Set the paper size to be A4, with a 2cm margin
|
27
|
+
%% all around the page.
|
28
|
+
\usepackage[a4paper,margin=2cm]{geometry}
|
29
|
+
|
30
|
+
%% Natbib is a popular style for formatting references.
|
31
|
+
\usepackage{natbib}
|
32
|
+
%% bibpunct sets the punctuation used for formatting citations.
|
33
|
+
\bibpunct{(}{)}{;}{a}{,}{,}
|
34
|
+
|
35
|
+
%% textcomp provides extra control sequences for accessing text symbols:
|
36
|
+
\usepackage{textcomp}
|
37
|
+
\newcommand*{\micro}{\textmu}
|
38
|
+
%% Here, we define the \micro command to print a text "mu".
|
39
|
+
%% "\newcommand" returns an error if "\micro" is already defined.
|
40
|
+
|
41
|
+
%% This is an example of a new macro that I've created to save me
|
42
|
+
%% having to type \LaTeX each time. The xspace command provides space
|
43
|
+
%% after the word LaTeX where appropriate.
|
44
|
+
\usepackage{xspace}
|
45
|
+
\providecommand*{\latex}{\LaTeX\xspace}
|
46
|
+
%% "\providecommand" does nothing if "\latex" is already defined.
|
47
|
+
|
48
|
+
|
49
|
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
50
|
+
%% Start of the document.
|
51
|
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
52
|
+
|
53
|
+
\begin{document}
|
54
|
+
|
55
|
+
\author{Stephen J. Eglen\\
|
56
|
+
Department of Applied Mathematics and Theoretical Physics\\
|
57
|
+
University of Cambridge\\
|
58
|
+
Wilberforce Road\\
|
59
|
+
Cambridge CB3 0WA U.K.}
|
60
|
+
\date{\today}
|
61
|
+
\title{A short example of how to use \latex for scientific reports}
|
62
|
+
\maketitle
|
63
|
+
|
64
|
+
\begin{abstract}
|
65
|
+
The purpose of this short document is to provide a brief overview of
|
66
|
+
the facilities that \latex offers for formatting scientific reports.
|
67
|
+
Furthermore, the source files for regenerating this report are
|
68
|
+
freely available so that users can easily start writing their own
|
69
|
+
reports using \latex.
|
70
|
+
\end{abstract}
|
71
|
+
|
72
|
+
\section{Introduction}
|
73
|
+
|
74
|
+
\latex is a typesetting program; given an input file with formatting
|
75
|
+
instructions (e.g intro.tex), the program will create your document in
|
76
|
+
one of several formats (DVI, Postscript or PDF). It is therefore not
|
77
|
+
a WYSIWYG word processor. \latex is known as a logical markup
|
78
|
+
language, similar for example to HTML, so that you describe a piece of
|
79
|
+
text as a ``section heading'' rather than saying that it should be
|
80
|
+
formatted in a certain way. It has excellent facilities for
|
81
|
+
typesetting mathematics, and handles large documents (such as theses)
|
82
|
+
well. The aim of this document is not to provide an overview of
|
83
|
+
\latex, since many other guides have already been written (see
|
84
|
+
Section~\ref{sec:summary}). Instead, it has been written primarily to
|
85
|
+
provide simple workable examples that you can cut and paste to help
|
86
|
+
you get started with \latex. The examples have been selected to be
|
87
|
+
those most likely to be useful when writing a scientific report. This
|
88
|
+
document is best read by comparing the source code with the resulting
|
89
|
+
output.
|
90
|
+
|
91
|
+
\section{Running \latex}
|
92
|
+
|
93
|
+
The files to accompany this paper are at:
|
94
|
+
\url{http://www.damtp.cam.ac.uk/user/eglen/texintro}. Get the
|
95
|
+
following files and put them into a new directory.
|
96
|
+
|
97
|
+
\begin{enumerate}
|
98
|
+
\item \url{intro.tex}: the main \latex document.
|
99
|
+
\item \url{example.bib}: a short bibliography.
|
100
|
+
\item \url{sigmoid.ps}: example postscript image.
|
101
|
+
\item \url{sigmoid.pdf}: example PDF image.
|
102
|
+
\end{enumerate}
|
103
|
+
|
104
|
+
Change directory to where you stored the files and type the
|
105
|
+
following (ignoring comments placed after \#\#):
|
106
|
+
|
107
|
+
\begin{verbatim}
|
108
|
+
latex intro ## Run latex 1st time.
|
109
|
+
bibtex intro ## Extract required references
|
110
|
+
latex intro ## Run latex 2nd to resolve references.
|
111
|
+
latex intro ## Probably need to run latex a 3rd time.
|
112
|
+
xdvi intro ## View the DVI (device independent) file.
|
113
|
+
dvips -o intro.ps intro ## Create a postscript file for printing.
|
114
|
+
\end{verbatim}
|
115
|
+
|
116
|
+
You will notice that you run latex several times here; this is so that
|
117
|
+
references can be resolved, and references can be extracted from your
|
118
|
+
bibtex file. After running latex, you will be told if you need to run
|
119
|
+
it again to resolve references. After a while, you will get the idea
|
120
|
+
of how many times you need to run latex to resolve all your
|
121
|
+
references.
|
122
|
+
|
123
|
+
If instead you would like to generate PDF files (see
|
124
|
+
Section~\ref{sec:graphics} for a discussion of file formats for
|
125
|
+
included images), you can try the following shorter sequence:
|
126
|
+
|
127
|
+
\begin{verbatim}
|
128
|
+
pdflatex intro
|
129
|
+
bibtex intro
|
130
|
+
pdflatex intro
|
131
|
+
pdflatex intro
|
132
|
+
xpdf intro.pdf ## View the resulting PDF
|
133
|
+
\end{verbatim}
|
134
|
+
|
135
|
+
Whether you prefer to generate DVI or PDF is up to you. The xdvi
|
136
|
+
viewer has some nice features, such as it can reload your document
|
137
|
+
easily and has a ``magnifying glass'' that is activated by the mouse.
|
138
|
+
On the other hand, xpdf will display the document more accurately as
|
139
|
+
it will be printed.
|
140
|
+
|
141
|
+
\section{Tables}
|
142
|
+
|
143
|
+
Tables are relatively straightforward to generate. Note that tables
|
144
|
+
and figures are not always placed exactly where you wish, as
|
145
|
+
they can \textit{float} to other parts of the document. Rather than
|
146
|
+
trying to battle with \latex as to where they are placed, concentrate
|
147
|
+
first on getting the right content and let \latex worry about the
|
148
|
+
positioning. Instead, use labels to your tables to refer to them.
|
149
|
+
See Table~\ref{tab:simple} and Table~\ref{tab:pars} for examples.
|
150
|
+
|
151
|
+
\begin{table}
|
152
|
+
\centering
|
153
|
+
\begin{tabular}{ccc}
|
154
|
+
year & min temp (\textdegree C) & max temp (\textdegree C)\\
|
155
|
+
\hline
|
156
|
+
1970 & $-5$ & 35\\
|
157
|
+
1975 & $-7$ & 29\\
|
158
|
+
1980 & $-3$ & 30\\
|
159
|
+
1985 & $-2$ & 32\\
|
160
|
+
\end{tabular}
|
161
|
+
\caption{Fictional minimal and maximal temperatures recorded in
|
162
|
+
Cambridge over several years.}
|
163
|
+
\label{tab:simple}
|
164
|
+
\end{table}
|
165
|
+
%% Why are the negative numbers above enclosed in math mode?
|
166
|
+
%% Hint: consider the difference between "-" in text and in math.
|
167
|
+
|
168
|
+
\begin{table}[htbp]
|
169
|
+
\centering
|
170
|
+
\begin{tabular}{lccc}\\ \hline
|
171
|
+
& \multicolumn{1}{c}{$\phi$ (\micro m)}
|
172
|
+
& \multicolumn{1}{c}{$\alpha$}
|
173
|
+
& $\delta_{12}$ (\micro m)\\ \hline
|
174
|
+
W81S1\\
|
175
|
+
$h_{11}(u)$ & 67.94 & 7.81\\
|
176
|
+
$h_{22}(u)$ & 66.27 & 5.40\\
|
177
|
+
$h_{12}(u)$ & & &18\\
|
178
|
+
\hline
|
179
|
+
M623\\
|
180
|
+
$h_{11}(u)$ &112.79 & 3.05\\
|
181
|
+
$h_{22}(u)$ & 65.46 & 8.11\\
|
182
|
+
$h_{12}(u)$ & & &20\\
|
183
|
+
\hline
|
184
|
+
\end{tabular}
|
185
|
+
\caption{Summary of parameter estimates for the univariate
|
186
|
+
functions $h_{11}(u)$, $h_{22}(u)$ and the bivariate function
|
187
|
+
$h_{12}(u)$. For the univariate fits, $\alpha$ and $\phi$ are
|
188
|
+
least-square estimates (assuming $\delta$ was fixed at 15 \micro m).
|
189
|
+
The final column gives the
|
190
|
+
maximum likelihood estimate of $\delta_{12}$ assuming that the
|
191
|
+
interaction between types is simple inhibition.
|
192
|
+
\label{tab:pars}}
|
193
|
+
\end{table}
|
194
|
+
|
195
|
+
|
196
|
+
\section{Bibliography management}
|
197
|
+
|
198
|
+
Scientific reports normally require a section where your references
|
199
|
+
are listed. Bibtex is an excellent system for maintaining references,
|
200
|
+
especially for large documents. Each reference needs a unique key;
|
201
|
+
you can then refer to the reference in your \latex document by using
|
202
|
+
this key within a cite command.
|
203
|
+
|
204
|
+
Take care when formatting your references, especially when it comes to
|
205
|
+
writing authors names and the case of letters in journal titles. In
|
206
|
+
our examples, the files are found in \url{example.bib}. As an example
|
207
|
+
of a citation, see \citep{ihaka1996} or \citep{ihaka1996,venables1999}.
|
208
|
+
|
209
|
+
Bibtex is flexible enough to format your references in a wide number
|
210
|
+
of different styles to suit your needs. In this file I have used the
|
211
|
+
``natbib'' package, which is suitable for the natural sciences.
|
212
|
+
Depending on the type of cite command you get (and the package that
|
213
|
+
you use for citations), you can get different styles of citation. See
|
214
|
+
Table~\ref{tab:cite} for some examples.
|
215
|
+
|
216
|
+
\begin{table}
|
217
|
+
\centering
|
218
|
+
\begin{tabular}{ll}
|
219
|
+
\hline
|
220
|
+
command & result\\ \hline
|
221
|
+
\verb+\citep{ihaka1996}+ & \citep{ihaka1996}\\
|
222
|
+
\verb+\citet{ihaka1996}+ & \citet{ihaka1996}\\
|
223
|
+
\verb+\citep[see][p. 300]{ihaka1996}+ &
|
224
|
+
\citep[see][p. 300]{ihaka1996}
|
225
|
+
\\
|
226
|
+
\verb+\citeauthor{ihaka1996}+ & \citeauthor{ihaka1996}
|
227
|
+
\\
|
228
|
+
\verb+\citeyear{ihaka1996}+ & \citeyear{ihaka1996}
|
229
|
+
\\
|
230
|
+
\hline
|
231
|
+
\end{tabular}
|
232
|
+
\caption{Examples of different citation commands available in the
|
233
|
+
natbib package.}
|
234
|
+
\label{tab:cite}
|
235
|
+
\end{table}
|
236
|
+
|
237
|
+
|
238
|
+
\section{Graphics}
|
239
|
+
\label{sec:graphics}
|
240
|
+
|
241
|
+
\latex can include images in one of several format, depending on
|
242
|
+
whether you use latex (postscript format required) or pdflatex (either
|
243
|
+
jpeg, png or pdf required). Figures can be included either at their
|
244
|
+
natural size, or you can specify e.g. the figure width.
|
245
|
+
Figure~\ref{fig:example} shows an example image which intentionally
|
246
|
+
looks slightly different depending on whether you compile the document
|
247
|
+
with latex or pdflatex. Note that in this example the suffix of the
|
248
|
+
image file is not included so that this document compiles under both
|
249
|
+
latex and pdflatex.
|
250
|
+
|
251
|
+
\begin{figure}
|
252
|
+
\centering
|
253
|
+
\includegraphics[width=6cm]{sigmoid}
|
254
|
+
\caption{Example of a sigmoidal curve generated by the R programming
|
255
|
+
environment. The title above the curve indicates whether you have
|
256
|
+
included the postscript or the pdf version of the figure.}
|
257
|
+
\label{fig:example}
|
258
|
+
\end{figure}
|
259
|
+
|
260
|
+
\section{Mathematics}
|
261
|
+
|
262
|
+
\latex can format mathematics with ease, either in line, such as
|
263
|
+
$x \times y$, or on separate lines, such as:
|
264
|
+
\[ x^2 +y^2 = z^2 \]
|
265
|
+
|
266
|
+
If you are writing several lines of equations, you can use statements
|
267
|
+
like the following:
|
268
|
+
|
269
|
+
\begin{align}
|
270
|
+
b(t) & = s(t) - \int_{0}^{T} a(t') \cdot i(T-t') dt'
|
271
|
+
\\
|
272
|
+
a(t) & = \int_{0}^{T} b(t) \cdot e(T-t') dt' \label{eq:am}
|
273
|
+
\\
|
274
|
+
g(t) & = b(t) \ast e(t) \nonumber
|
275
|
+
\end{align}
|
276
|
+
|
277
|
+
By using labels on certain equations, we can refer to equations by
|
278
|
+
number, such as equation~(\ref{eq:am}).
|
279
|
+
|
280
|
+
\section{Summary}
|
281
|
+
\label{sec:summary}
|
282
|
+
This short guide should give you a flavour of what can be done with
|
283
|
+
\latex. It is by no means complete, or supposed to be
|
284
|
+
self-explanatory. It is, however, hopefully enough to get you
|
285
|
+
started! Try experimenting by editing the source file and then
|
286
|
+
recompiling this document. As mentioned earlier, there are many
|
287
|
+
guides for latex. Two that I can recommend are
|
288
|
+
\url{http://www.andy-roberts.net/misc/latex/index.html} and
|
289
|
+
`` The (Not So) Short Introduction to LaTeX2e''
|
290
|
+
(\url{http://ctan.tug.org/tex-archive/info/lshort/english/lshort.pdf}).
|
291
|
+
|
292
|
+
|
293
|
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
294
|
+
%% Finally we specify the format required for our references and the
|
295
|
+
%% name of the bibtex file where our references should be taken from.
|
296
|
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
297
|
+
|
298
|
+
\bibliographystyle{plainnat}
|
299
|
+
\bibliography{example}
|
300
|
+
|
301
|
+
\end{document}
|
302
|
+
|
303
|
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
304
|
+
%% The end.
|
305
305
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|