aspose_pdf_cloud 20.12.0 → 21.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (409) hide show
  1. checksums.yaml +4 -4
  2. data/Examples/delete_annotation.rb +22 -0
  3. data/Examples/delete_document_annotations.rb +18 -0
  4. data/Examples/delete_page_annotations.rb +17 -0
  5. data/Examples/example_data/PdfWithAnnotations.pdf +0 -0
  6. data/Examples/get_carret_annotation.rb +20 -0
  7. data/Examples/get_circle_annotation.rb +21 -0
  8. data/Examples/get_circle_annotations.rb +17 -0
  9. data/Examples/get_document_annotations.rb +15 -0
  10. data/Examples/get_document_free_text_annotations.rb +17 -0
  11. data/Examples/get_document_highlight_annotations.rb +16 -0
  12. data/Examples/get_document_ink_annotations.rb +15 -0
  13. data/Examples/get_document_line_annotations.rb +16 -0
  14. data/Examples/get_document_movie_annotations.rb +16 -0
  15. data/Examples/get_document_polygon_annotations.rb +16 -0
  16. data/Examples/get_document_polyline_annotations.rb +17 -0
  17. data/Examples/get_document_popup_annotation_by_parent.rb +17 -0
  18. data/Examples/get_document_popup_annotations.rb +16 -0
  19. data/Examples/get_document_redaction_annotations.rb +16 -0
  20. data/Examples/get_document_screen_annotations.rb +17 -0
  21. data/Examples/get_document_sound_annotations.rb +18 -0
  22. data/Examples/get_document_squiggly_annotations.rb +18 -0
  23. data/Examples/get_document_stamp_annotations.rb +17 -0
  24. data/Examples/get_document_strike_out_annotation.rb +17 -0
  25. data/Examples/get_document_text_annotations.rb +17 -0
  26. data/Examples/get_document_underline_annotations.rb +17 -0
  27. data/Examples/get_documnet_carret_annotation.rb +17 -0
  28. data/Examples/get_file_attachment_annotation.rb +21 -0
  29. data/Examples/get_file_attachment_annotation_data.rb +21 -0
  30. data/Examples/get_file_attachment_annotations.rb +19 -0
  31. data/Examples/get_free_text_annotation.rb +20 -0
  32. data/Examples/get_hightlight_annotations.rb +20 -0
  33. data/Examples/get_ink_annotation.rb +21 -0
  34. data/Examples/get_line_annotation.rb +20 -0
  35. data/Examples/get_movie_annotation.rb +20 -0
  36. data/Examples/get_page_annotations.rb +19 -0
  37. data/Examples/get_page_carret_annotations.rb +17 -0
  38. data/Examples/get_page_file_attachment_annotations.rb +19 -0
  39. data/Examples/get_page_free_text_annotations.rb +18 -0
  40. data/Examples/get_page_highlight_annotations.rb +18 -0
  41. data/Examples/get_page_ink_annotations.rb +17 -0
  42. data/Examples/get_page_line_annotations.rb +17 -0
  43. data/Examples/get_page_movie_annotations.rb +18 -0
  44. data/Examples/get_page_polygon_annotations.rb +18 -0
  45. data/Examples/get_page_polyline_annotations.rb +21 -0
  46. data/Examples/get_page_redaction_annotations.rb +17 -0
  47. data/Examples/get_page_screen_annotations.rb +19 -0
  48. data/Examples/get_page_sound_annotations.rb +20 -0
  49. data/Examples/get_page_square_annotations.rb +18 -0
  50. data/Examples/get_page_squiggly_annotations.rb +17 -0
  51. data/Examples/get_page_stamp_annotations.rb +17 -0
  52. data/Examples/get_page_strikeout_annotations.rb +17 -0
  53. data/Examples/get_page_text_annotations.rb +17 -0
  54. data/Examples/get_page_underline_annotations.rb +17 -0
  55. data/Examples/get_polygon_annotation.rb +20 -0
  56. data/Examples/get_polyline_annotation.rb +22 -0
  57. data/Examples/get_redaction_annotation.rb +19 -0
  58. data/Examples/get_screen_annotation.rb +22 -0
  59. data/Examples/get_screen_annotation_data.rb +19 -0
  60. data/Examples/get_screen_annotations.rb +21 -0
  61. data/Examples/get_sound_annotation.rb +25 -0
  62. data/Examples/get_sound_annotation_data.rb +19 -0
  63. data/Examples/get_square_annotation.rb +19 -0
  64. data/Examples/get_squiggly_annotation.rb +19 -0
  65. data/Examples/get_stamp_annotation.rb +20 -0
  66. data/Examples/get_stamp_annotation_data.rb +20 -0
  67. data/Examples/get_strike_out_annotation.rb +19 -0
  68. data/Examples/get_text_annotation.rb +19 -0
  69. data/Examples/get_underline_annotation.rb +19 -0
  70. data/Examples/post_page_carret_annotations.rb +28 -0
  71. data/Examples/post_page_circle_annotations.rb +27 -0
  72. data/Examples/post_page_file_attachnment_annotations.rb +38 -0
  73. data/Examples/post_page_free_text_annotations.rb +35 -0
  74. data/Examples/post_page_hightlight_annotations.rb +32 -0
  75. data/Examples/post_page_ink_annotations.rb +39 -0
  76. data/Examples/post_page_line_annotations.rb +28 -0
  77. data/Examples/post_page_movie_annotations.rb +30 -0
  78. data/Examples/post_page_polygon_annotations.rb +33 -0
  79. data/Examples/post_page_polyline_annotations.rb +35 -0
  80. data/Examples/post_page_redaction_annotations.rb +28 -0
  81. data/Examples/post_page_screen_annotations.rb +31 -0
  82. data/Examples/post_page_sound_annotations.rb +35 -0
  83. data/Examples/post_page_square_annotations.rb +27 -0
  84. data/Examples/post_page_squiggly_annotations.rb +33 -0
  85. data/Examples/post_page_stamp_annotations.rb +34 -0
  86. data/Examples/post_page_strike_out_annotation.rb +33 -0
  87. data/Examples/post_page_text_annotations.rb +26 -0
  88. data/Examples/post_page_underline_annotations.rb +33 -0
  89. data/Examples/post_popup_annotation.rb +25 -0
  90. data/Examples/put_annotations_flatten.rb +20 -0
  91. data/Examples/put_carret_annotation.rb +30 -0
  92. data/Examples/put_circle_annotation.rb +29 -0
  93. data/Examples/put_file_attachment_annotation.rb +38 -0
  94. data/Examples/put_file_attachment_annotion_data_extract.rb +21 -0
  95. data/Examples/put_free_text_annotation.rb +38 -0
  96. data/Examples/put_highlight_annotation.rb +34 -0
  97. data/Examples/put_ink_annotation.rb +41 -0
  98. data/Examples/put_line_annotation.rb +30 -0
  99. data/Examples/put_movie_annotation.rb +31 -0
  100. data/Examples/put_polygon_annotation.rb +35 -0
  101. data/Examples/put_polyline_annotation.rb +36 -0
  102. data/Examples/put_redaction_annotation.rb +31 -0
  103. data/Examples/put_screen_annotation.rb +33 -0
  104. data/Examples/put_screen_annotation_data_extract.rb +19 -0
  105. data/Examples/put_sound_annotation.rb +42 -0
  106. data/Examples/put_sound_annotation_data_extract.rb +20 -0
  107. data/Examples/put_square_annotation.rb +28 -0
  108. data/Examples/put_squiggly_annotation.rb +35 -0
  109. data/Examples/put_stamp_annotation.rb +35 -0
  110. data/Examples/put_strike_out_annotation.rb +35 -0
  111. data/Examples/put_text_annotation.rb +29 -0
  112. data/Examples/put_underline_annotation.rb +35 -0
  113. data/README.md +71 -51
  114. data/aspose_pdf_cloud.gemspec +53 -53
  115. data/docs/PdfApi.md +6 -102
  116. data/docs/TextReplace.md +1 -1
  117. data/lib/aspose_pdf_cloud/api/pdf_api.rb +29142 -29427
  118. data/lib/aspose_pdf_cloud/api_client.rb +1 -1
  119. data/lib/aspose_pdf_cloud/api_error.rb +47 -47
  120. data/lib/aspose_pdf_cloud/configuration.rb +172 -172
  121. data/lib/aspose_pdf_cloud/models/annotation.rb +318 -318
  122. data/lib/aspose_pdf_cloud/models/annotation_flags.rb +53 -53
  123. data/lib/aspose_pdf_cloud/models/annotation_info.rb +333 -333
  124. data/lib/aspose_pdf_cloud/models/annotation_state.rb +50 -50
  125. data/lib/aspose_pdf_cloud/models/annotation_type.rb +70 -70
  126. data/lib/aspose_pdf_cloud/models/annotations_info.rb +213 -213
  127. data/lib/aspose_pdf_cloud/models/annotations_info_response.rb +224 -224
  128. data/lib/aspose_pdf_cloud/models/antialiasing_processing_type.rb +44 -44
  129. data/lib/aspose_pdf_cloud/models/aspose_response.rb +214 -214
  130. data/lib/aspose_pdf_cloud/models/attachment.rb +276 -276
  131. data/lib/aspose_pdf_cloud/models/attachment_response.rb +224 -224
  132. data/lib/aspose_pdf_cloud/models/attachments.rb +213 -213
  133. data/lib/aspose_pdf_cloud/models/attachments_response.rb +224 -224
  134. data/lib/aspose_pdf_cloud/models/bookmark.rb +361 -361
  135. data/lib/aspose_pdf_cloud/models/bookmark_response.rb +224 -224
  136. data/lib/aspose_pdf_cloud/models/bookmarks.rb +213 -213
  137. data/lib/aspose_pdf_cloud/models/bookmarks_response.rb +224 -224
  138. data/lib/aspose_pdf_cloud/models/border.rb +249 -249
  139. data/lib/aspose_pdf_cloud/models/border_corner_style.rb +44 -44
  140. data/lib/aspose_pdf_cloud/models/border_effect.rb +44 -44
  141. data/lib/aspose_pdf_cloud/models/border_info.rb +239 -239
  142. data/lib/aspose_pdf_cloud/models/border_style.rb +47 -47
  143. data/lib/aspose_pdf_cloud/models/box_style.rb +48 -48
  144. data/lib/aspose_pdf_cloud/models/cap_style.rb +44 -44
  145. data/lib/aspose_pdf_cloud/models/caption_position.rb +44 -44
  146. data/lib/aspose_pdf_cloud/models/caret_annotation.rb +378 -378
  147. data/lib/aspose_pdf_cloud/models/caret_annotation_response.rb +224 -224
  148. data/lib/aspose_pdf_cloud/models/caret_annotations.rb +213 -213
  149. data/lib/aspose_pdf_cloud/models/caret_annotations_response.rb +224 -224
  150. data/lib/aspose_pdf_cloud/models/caret_symbol.rb +44 -44
  151. data/lib/aspose_pdf_cloud/models/cell.rb +353 -353
  152. data/lib/aspose_pdf_cloud/models/cell_recognized.rb +209 -209
  153. data/lib/aspose_pdf_cloud/models/check_box_field.rb +455 -455
  154. data/lib/aspose_pdf_cloud/models/check_box_field_response.rb +224 -224
  155. data/lib/aspose_pdf_cloud/models/check_box_fields.rb +213 -213
  156. data/lib/aspose_pdf_cloud/models/check_box_fields_response.rb +224 -224
  157. data/lib/aspose_pdf_cloud/models/choice_field.rb +418 -418
  158. data/lib/aspose_pdf_cloud/models/circle_annotation.rb +378 -378
  159. data/lib/aspose_pdf_cloud/models/circle_annotation_response.rb +224 -224
  160. data/lib/aspose_pdf_cloud/models/circle_annotations.rb +213 -213
  161. data/lib/aspose_pdf_cloud/models/circle_annotations_response.rb +224 -224
  162. data/lib/aspose_pdf_cloud/models/color.rb +249 -249
  163. data/lib/aspose_pdf_cloud/models/color_depth.rb +46 -46
  164. data/lib/aspose_pdf_cloud/models/column_adjustment.rb +45 -45
  165. data/lib/aspose_pdf_cloud/models/combo_box_field.rb +460 -460
  166. data/lib/aspose_pdf_cloud/models/combo_box_field_response.rb +224 -224
  167. data/lib/aspose_pdf_cloud/models/combo_box_fields.rb +213 -213
  168. data/lib/aspose_pdf_cloud/models/combo_box_fields_response.rb +224 -224
  169. data/lib/aspose_pdf_cloud/models/common_figure_annotation.rb +378 -378
  170. data/lib/aspose_pdf_cloud/models/compression_type.rb +47 -47
  171. data/lib/aspose_pdf_cloud/models/crypto_algorithm.rb +46 -46
  172. data/lib/aspose_pdf_cloud/models/dash.rb +219 -219
  173. data/lib/aspose_pdf_cloud/models/default_page_config.rb +209 -209
  174. data/lib/aspose_pdf_cloud/models/direction.rb +44 -44
  175. data/lib/aspose_pdf_cloud/models/disc_usage.rb +219 -219
  176. data/lib/aspose_pdf_cloud/models/display_properties.rb +291 -291
  177. data/lib/aspose_pdf_cloud/models/display_properties_response.rb +224 -224
  178. data/lib/aspose_pdf_cloud/models/doc_format.rb +44 -44
  179. data/lib/aspose_pdf_cloud/models/doc_mdp_access_permission_type.rb +45 -45
  180. data/lib/aspose_pdf_cloud/models/doc_recognition_mode.rb +44 -44
  181. data/lib/aspose_pdf_cloud/models/document.rb +231 -231
  182. data/lib/aspose_pdf_cloud/models/document_config.rb +234 -234
  183. data/lib/aspose_pdf_cloud/models/document_page_response.rb +224 -224
  184. data/lib/aspose_pdf_cloud/models/document_pages_response.rb +224 -224
  185. data/lib/aspose_pdf_cloud/models/document_privilege.rb +299 -299
  186. data/lib/aspose_pdf_cloud/models/document_properties.rb +213 -213
  187. data/lib/aspose_pdf_cloud/models/document_properties_response.rb +224 -224
  188. data/lib/aspose_pdf_cloud/models/document_property.rb +236 -236
  189. data/lib/aspose_pdf_cloud/models/document_property_response.rb +224 -224
  190. data/lib/aspose_pdf_cloud/models/document_response.rb +236 -236
  191. data/lib/aspose_pdf_cloud/models/epub_recognition_mode.rb +45 -45
  192. data/lib/aspose_pdf_cloud/models/error.rb +229 -229
  193. data/lib/aspose_pdf_cloud/models/error_details.rb +214 -214
  194. data/lib/aspose_pdf_cloud/models/field.rb +260 -260
  195. data/lib/aspose_pdf_cloud/models/field_response.rb +224 -224
  196. data/lib/aspose_pdf_cloud/models/field_type.rb +46 -46
  197. data/lib/aspose_pdf_cloud/models/fields.rb +218 -218
  198. data/lib/aspose_pdf_cloud/models/fields_response.rb +224 -224
  199. data/lib/aspose_pdf_cloud/models/file_attachment_annotation.rb +408 -408
  200. data/lib/aspose_pdf_cloud/models/file_attachment_annotation_response.rb +224 -224
  201. data/lib/aspose_pdf_cloud/models/file_attachment_annotations.rb +213 -213
  202. data/lib/aspose_pdf_cloud/models/file_attachment_annotations_response.rb +224 -224
  203. data/lib/aspose_pdf_cloud/models/file_icon.rb +46 -46
  204. data/lib/aspose_pdf_cloud/models/file_version.rb +274 -274
  205. data/lib/aspose_pdf_cloud/models/file_versions.rb +201 -201
  206. data/lib/aspose_pdf_cloud/models/files_list.rb +201 -201
  207. data/lib/aspose_pdf_cloud/models/files_upload_result.rb +213 -213
  208. data/lib/aspose_pdf_cloud/models/font_encoding_rules.rb +44 -44
  209. data/lib/aspose_pdf_cloud/models/font_saving_modes.rb +46 -46
  210. data/lib/aspose_pdf_cloud/models/font_styles.rb +46 -46
  211. data/lib/aspose_pdf_cloud/models/form_field.rb +398 -398
  212. data/lib/aspose_pdf_cloud/models/free_text_annotation.rb +403 -403
  213. data/lib/aspose_pdf_cloud/models/free_text_annotation_response.rb +224 -224
  214. data/lib/aspose_pdf_cloud/models/free_text_annotations.rb +213 -213
  215. data/lib/aspose_pdf_cloud/models/free_text_annotations_response.rb +224 -224
  216. data/lib/aspose_pdf_cloud/models/free_text_intent.rb +45 -45
  217. data/lib/aspose_pdf_cloud/models/graph_info.rb +301 -301
  218. data/lib/aspose_pdf_cloud/models/highlight_annotation.rb +370 -370
  219. data/lib/aspose_pdf_cloud/models/highlight_annotation_response.rb +224 -224
  220. data/lib/aspose_pdf_cloud/models/highlight_annotations.rb +213 -213
  221. data/lib/aspose_pdf_cloud/models/highlight_annotations_response.rb +224 -224
  222. data/lib/aspose_pdf_cloud/models/horizontal_alignment.rb +46 -46
  223. data/lib/aspose_pdf_cloud/models/html_document_type.rb +44 -44
  224. data/lib/aspose_pdf_cloud/models/html_markup_generation_modes.rb +44 -44
  225. data/lib/aspose_pdf_cloud/models/image.rb +266 -266
  226. data/lib/aspose_pdf_cloud/models/image_compression_version.rb +45 -45
  227. data/lib/aspose_pdf_cloud/models/image_encoding.rb +46 -46
  228. data/lib/aspose_pdf_cloud/models/image_footer.rb +341 -341
  229. data/lib/aspose_pdf_cloud/models/image_fragment.rb +283 -283
  230. data/lib/aspose_pdf_cloud/models/image_header.rb +341 -341
  231. data/lib/aspose_pdf_cloud/models/image_response.rb +224 -224
  232. data/lib/aspose_pdf_cloud/models/image_src_type.rb +44 -44
  233. data/lib/aspose_pdf_cloud/models/image_stamp.rb +361 -361
  234. data/lib/aspose_pdf_cloud/models/image_template.rb +301 -301
  235. data/lib/aspose_pdf_cloud/models/image_templates_request.rb +231 -231
  236. data/lib/aspose_pdf_cloud/models/images.rb +213 -213
  237. data/lib/aspose_pdf_cloud/models/images_response.rb +224 -224
  238. data/lib/aspose_pdf_cloud/models/ink_annotation.rb +380 -380
  239. data/lib/aspose_pdf_cloud/models/ink_annotation_response.rb +224 -224
  240. data/lib/aspose_pdf_cloud/models/ink_annotations.rb +213 -213
  241. data/lib/aspose_pdf_cloud/models/ink_annotations_response.rb +224 -224
  242. data/lib/aspose_pdf_cloud/models/justification.rb +45 -45
  243. data/lib/aspose_pdf_cloud/models/letters_positioning_methods.rb +44 -44
  244. data/lib/aspose_pdf_cloud/models/line_annotation.rb +488 -488
  245. data/lib/aspose_pdf_cloud/models/line_annotation_response.rb +224 -224
  246. data/lib/aspose_pdf_cloud/models/line_annotations.rb +213 -213
  247. data/lib/aspose_pdf_cloud/models/line_annotations_response.rb +224 -224
  248. data/lib/aspose_pdf_cloud/models/line_ending.rb +52 -52
  249. data/lib/aspose_pdf_cloud/models/line_intent.rb +45 -45
  250. data/lib/aspose_pdf_cloud/models/line_spacing.rb +44 -44
  251. data/lib/aspose_pdf_cloud/models/link.rb +229 -229
  252. data/lib/aspose_pdf_cloud/models/link_action_type.rb +48 -48
  253. data/lib/aspose_pdf_cloud/models/link_annotation.rb +294 -294
  254. data/lib/aspose_pdf_cloud/models/link_annotation_response.rb +224 -224
  255. data/lib/aspose_pdf_cloud/models/link_annotations.rb +213 -213
  256. data/lib/aspose_pdf_cloud/models/link_annotations_response.rb +224 -224
  257. data/lib/aspose_pdf_cloud/models/link_element.rb +201 -201
  258. data/lib/aspose_pdf_cloud/models/link_highlighting_mode.rb +47 -47
  259. data/lib/aspose_pdf_cloud/models/list_box_field.rb +462 -462
  260. data/lib/aspose_pdf_cloud/models/list_box_field_response.rb +224 -224
  261. data/lib/aspose_pdf_cloud/models/list_box_fields.rb +213 -213
  262. data/lib/aspose_pdf_cloud/models/list_box_fields_response.rb +224 -224
  263. data/lib/aspose_pdf_cloud/models/margin_info.rb +229 -229
  264. data/lib/aspose_pdf_cloud/models/markup_annotation.rb +358 -358
  265. data/lib/aspose_pdf_cloud/models/merge_documents.rb +206 -206
  266. data/lib/aspose_pdf_cloud/models/movie_annotation.rb +348 -348
  267. data/lib/aspose_pdf_cloud/models/movie_annotation_response.rb +224 -224
  268. data/lib/aspose_pdf_cloud/models/movie_annotations.rb +213 -213
  269. data/lib/aspose_pdf_cloud/models/movie_annotations_response.rb +224 -224
  270. data/lib/aspose_pdf_cloud/models/object_exist.rb +219 -219
  271. data/lib/aspose_pdf_cloud/models/optimize_options.rb +319 -319
  272. data/lib/aspose_pdf_cloud/models/option.rb +229 -229
  273. data/lib/aspose_pdf_cloud/models/output_format.rb +44 -44
  274. data/lib/aspose_pdf_cloud/models/page.rb +236 -236
  275. data/lib/aspose_pdf_cloud/models/page_layout.rb +49 -49
  276. data/lib/aspose_pdf_cloud/models/page_mode.rb +48 -48
  277. data/lib/aspose_pdf_cloud/models/page_number_stamp.rb +351 -351
  278. data/lib/aspose_pdf_cloud/models/page_word_count.rb +219 -219
  279. data/lib/aspose_pdf_cloud/models/pages.rb +213 -213
  280. data/lib/aspose_pdf_cloud/models/paragraph.rb +316 -316
  281. data/lib/aspose_pdf_cloud/models/parts_embedding_modes.rb +45 -45
  282. data/lib/aspose_pdf_cloud/models/pdf_a_type.rb +45 -45
  283. data/lib/aspose_pdf_cloud/models/pdf_page_stamp.rb +351 -351
  284. data/lib/aspose_pdf_cloud/models/permissions_flags.rb +50 -50
  285. data/lib/aspose_pdf_cloud/models/point.rb +219 -219
  286. data/lib/aspose_pdf_cloud/models/poly_annotation.rb +415 -415
  287. data/lib/aspose_pdf_cloud/models/poly_intent.rb +46 -46
  288. data/lib/aspose_pdf_cloud/models/poly_line_annotation.rb +415 -415
  289. data/lib/aspose_pdf_cloud/models/poly_line_annotation_response.rb +224 -224
  290. data/lib/aspose_pdf_cloud/models/poly_line_annotations.rb +213 -213
  291. data/lib/aspose_pdf_cloud/models/poly_line_annotations_response.rb +224 -224
  292. data/lib/aspose_pdf_cloud/models/polygon_annotation.rb +415 -415
  293. data/lib/aspose_pdf_cloud/models/polygon_annotation_response.rb +224 -224
  294. data/lib/aspose_pdf_cloud/models/polygon_annotations.rb +213 -213
  295. data/lib/aspose_pdf_cloud/models/polygon_annotations_response.rb +224 -224
  296. data/lib/aspose_pdf_cloud/models/popup_annotation.rb +328 -328
  297. data/lib/aspose_pdf_cloud/models/popup_annotation_response.rb +224 -224
  298. data/lib/aspose_pdf_cloud/models/popup_annotation_with_parent.rb +338 -338
  299. data/lib/aspose_pdf_cloud/models/popup_annotations.rb +213 -213
  300. data/lib/aspose_pdf_cloud/models/popup_annotations_response.rb +224 -224
  301. data/lib/aspose_pdf_cloud/models/position.rb +219 -219
  302. data/lib/aspose_pdf_cloud/models/radio_button_field.rb +452 -452
  303. data/lib/aspose_pdf_cloud/models/radio_button_field_response.rb +224 -224
  304. data/lib/aspose_pdf_cloud/models/radio_button_fields.rb +213 -213
  305. data/lib/aspose_pdf_cloud/models/radio_button_fields_response.rb +224 -224
  306. data/lib/aspose_pdf_cloud/models/radio_button_option_field.rb +418 -418
  307. data/lib/aspose_pdf_cloud/models/raster_images_saving_modes.rb +45 -45
  308. data/lib/aspose_pdf_cloud/models/rectangle.rb +249 -249
  309. data/lib/aspose_pdf_cloud/models/redaction_annotation.rb +380 -380
  310. data/lib/aspose_pdf_cloud/models/redaction_annotation_response.rb +224 -224
  311. data/lib/aspose_pdf_cloud/models/redaction_annotations.rb +213 -213
  312. data/lib/aspose_pdf_cloud/models/redaction_annotations_response.rb +224 -224
  313. data/lib/aspose_pdf_cloud/models/rotation.rb +46 -46
  314. data/lib/aspose_pdf_cloud/models/row.rb +306 -306
  315. data/lib/aspose_pdf_cloud/models/row_recognized.rb +211 -211
  316. data/lib/aspose_pdf_cloud/models/screen_annotation.rb +338 -338
  317. data/lib/aspose_pdf_cloud/models/screen_annotation_response.rb +224 -224
  318. data/lib/aspose_pdf_cloud/models/screen_annotations.rb +213 -213
  319. data/lib/aspose_pdf_cloud/models/screen_annotations_response.rb +224 -224
  320. data/lib/aspose_pdf_cloud/models/segment.rb +233 -233
  321. data/lib/aspose_pdf_cloud/models/shape_type.rb +45 -45
  322. data/lib/aspose_pdf_cloud/models/signature.rb +388 -388
  323. data/lib/aspose_pdf_cloud/models/signature_custom_appearance.rb +329 -329
  324. data/lib/aspose_pdf_cloud/models/signature_field.rb +408 -408
  325. data/lib/aspose_pdf_cloud/models/signature_field_response.rb +224 -224
  326. data/lib/aspose_pdf_cloud/models/signature_fields.rb +213 -213
  327. data/lib/aspose_pdf_cloud/models/signature_fields_response.rb +224 -224
  328. data/lib/aspose_pdf_cloud/models/signature_type.rb +45 -45
  329. data/lib/aspose_pdf_cloud/models/signature_verify_response.rb +229 -229
  330. data/lib/aspose_pdf_cloud/models/sound_annotation.rb +442 -442
  331. data/lib/aspose_pdf_cloud/models/sound_annotation_response.rb +224 -224
  332. data/lib/aspose_pdf_cloud/models/sound_annotations.rb +213 -213
  333. data/lib/aspose_pdf_cloud/models/sound_annotations_response.rb +224 -224
  334. data/lib/aspose_pdf_cloud/models/sound_encoding.rb +46 -46
  335. data/lib/aspose_pdf_cloud/models/sound_icon.rb +44 -44
  336. data/lib/aspose_pdf_cloud/models/split_result.rb +201 -201
  337. data/lib/aspose_pdf_cloud/models/split_result_document.rb +244 -244
  338. data/lib/aspose_pdf_cloud/models/split_result_response.rb +224 -224
  339. data/lib/aspose_pdf_cloud/models/square_annotation.rb +378 -378
  340. data/lib/aspose_pdf_cloud/models/square_annotation_response.rb +224 -224
  341. data/lib/aspose_pdf_cloud/models/square_annotations.rb +213 -213
  342. data/lib/aspose_pdf_cloud/models/square_annotations_response.rb +224 -224
  343. data/lib/aspose_pdf_cloud/models/squiggly_annotation.rb +370 -370
  344. data/lib/aspose_pdf_cloud/models/squiggly_annotation_response.rb +224 -224
  345. data/lib/aspose_pdf_cloud/models/squiggly_annotations.rb +213 -213
  346. data/lib/aspose_pdf_cloud/models/squiggly_annotations_response.rb +224 -224
  347. data/lib/aspose_pdf_cloud/models/stamp.rb +414 -414
  348. data/lib/aspose_pdf_cloud/models/stamp_annotation.rb +388 -388
  349. data/lib/aspose_pdf_cloud/models/stamp_annotation_response.rb +224 -224
  350. data/lib/aspose_pdf_cloud/models/stamp_annotations.rb +213 -213
  351. data/lib/aspose_pdf_cloud/models/stamp_annotations_response.rb +224 -224
  352. data/lib/aspose_pdf_cloud/models/stamp_base.rb +281 -281
  353. data/lib/aspose_pdf_cloud/models/stamp_icon.rb +56 -56
  354. data/lib/aspose_pdf_cloud/models/stamp_info.rb +276 -276
  355. data/lib/aspose_pdf_cloud/models/stamp_type.rb +46 -46
  356. data/lib/aspose_pdf_cloud/models/stamps_info.rb +213 -213
  357. data/lib/aspose_pdf_cloud/models/stamps_info_response.rb +224 -224
  358. data/lib/aspose_pdf_cloud/models/storage_exist.rb +204 -204
  359. data/lib/aspose_pdf_cloud/models/storage_file.rb +249 -249
  360. data/lib/aspose_pdf_cloud/models/strike_out_annotation.rb +370 -370
  361. data/lib/aspose_pdf_cloud/models/strike_out_annotation_response.rb +224 -224
  362. data/lib/aspose_pdf_cloud/models/strike_out_annotations.rb +213 -213
  363. data/lib/aspose_pdf_cloud/models/strike_out_annotations_response.rb +224 -224
  364. data/lib/aspose_pdf_cloud/models/table.rb +438 -438
  365. data/lib/aspose_pdf_cloud/models/table_broken.rb +45 -45
  366. data/lib/aspose_pdf_cloud/models/table_recognized.rb +243 -243
  367. data/lib/aspose_pdf_cloud/models/table_recognized_response.rb +224 -224
  368. data/lib/aspose_pdf_cloud/models/tables_recognized.rb +213 -213
  369. data/lib/aspose_pdf_cloud/models/tables_recognized_response.rb +224 -224
  370. data/lib/aspose_pdf_cloud/models/text_annotation.rb +388 -388
  371. data/lib/aspose_pdf_cloud/models/text_annotation_response.rb +224 -224
  372. data/lib/aspose_pdf_cloud/models/text_annotations.rb +213 -213
  373. data/lib/aspose_pdf_cloud/models/text_annotations_response.rb +224 -224
  374. data/lib/aspose_pdf_cloud/models/text_box_field.rb +458 -458
  375. data/lib/aspose_pdf_cloud/models/text_box_field_response.rb +224 -224
  376. data/lib/aspose_pdf_cloud/models/text_box_fields.rb +213 -213
  377. data/lib/aspose_pdf_cloud/models/text_box_fields_response.rb +224 -224
  378. data/lib/aspose_pdf_cloud/models/text_footer.rb +341 -341
  379. data/lib/aspose_pdf_cloud/models/text_header.rb +341 -341
  380. data/lib/aspose_pdf_cloud/models/text_horizontal_alignment.rb +48 -48
  381. data/lib/aspose_pdf_cloud/models/text_icon.rb +53 -53
  382. data/lib/aspose_pdf_cloud/models/text_line.rb +216 -216
  383. data/lib/aspose_pdf_cloud/models/text_rect.rb +269 -269
  384. data/lib/aspose_pdf_cloud/models/text_rects.rb +201 -201
  385. data/lib/aspose_pdf_cloud/models/text_rects_response.rb +224 -224
  386. data/lib/aspose_pdf_cloud/models/text_replace.rb +268 -292
  387. data/lib/aspose_pdf_cloud/models/text_replace_list_request.rb +236 -236
  388. data/lib/aspose_pdf_cloud/models/text_replace_response.rb +229 -229
  389. data/lib/aspose_pdf_cloud/models/text_stamp.rb +361 -361
  390. data/lib/aspose_pdf_cloud/models/text_state.rb +259 -259
  391. data/lib/aspose_pdf_cloud/models/text_style.rb +244 -244
  392. data/lib/aspose_pdf_cloud/models/timestamp_settings.rb +209 -209
  393. data/lib/aspose_pdf_cloud/models/underline_annotation.rb +370 -370
  394. data/lib/aspose_pdf_cloud/models/underline_annotation_response.rb +224 -224
  395. data/lib/aspose_pdf_cloud/models/underline_annotations.rb +213 -213
  396. data/lib/aspose_pdf_cloud/models/underline_annotations_response.rb +224 -224
  397. data/lib/aspose_pdf_cloud/models/vertical_alignment.rb +46 -46
  398. data/lib/aspose_pdf_cloud/models/word_count.rb +200 -200
  399. data/lib/aspose_pdf_cloud/models/word_count_response.rb +224 -224
  400. data/lib/aspose_pdf_cloud/models/wrap_mode.rb +45 -45
  401. data/lib/aspose_pdf_cloud/version.rb +24 -24
  402. data/lib/aspose_pdf_cloud.rb +325 -326
  403. data/test/pdf_tests.rb +1 -1
  404. data/test_data/FormDataXfdf_in.xfdf +21 -21
  405. data/test_data/TexExample.tex +304 -304
  406. data/test_data/sample.tex +105 -105
  407. metadata +117 -9
  408. data/docs/ApiInfo.md +0 -10
  409. 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
- Copyright (c) 2020 Aspose.PDF Cloud
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 &amp; 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 &amp; 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,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
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%