Instructions for SHEARWATER models including: Cloud Custom Software, Custom Software, Software

Shearwater Cloud Custom PDF Instructions

New PDF Export Navigation With the release of Shearwater Cloud 2.9.6 we added more options to the “Print to PDF” dialog. The first addition is the ability to choose the exported data font.

9 mars 2023 — Click on the “Export Templates” and save it to an easy to access folder location. Once a folder is selected, the PDF template files will be saved to the.


File Info : application/pdf, 17 Pages, 778.91KB

PDF preview unavailable. Download the PDF instead.

sw custom pdf instructions
Shearwater Cloud Custom PDF Instructions
Written by: Jason Jarvis Edited By: Shaun Evans Contributors: Shaun Evans Original authored Date: 2023 March 08 Last Updated: 2023 March 09
Introduction .....................................................................................................................................1 New PDF Export Navigation .............................................................................................................3 Custom PDF Options ........................................................................................................................3
Select Custom Template ..............................................................................................................4 Custom Template Help.................................................................................................................4 Modifying existing PDFs...................................................................................................................5 Form Editing .................................................................................................................................5 Form Property box .......................................................................................................................7 PDF Edit ........................................................................................................................................8 Creating a Custom Template from scratch....................................................................................11 PDF Form Editing ........................................................................................................................11 PDF Edit visual parts...................................................................................................................13 Technical Stuff for Form Fields ......................................................................................................16 Shearwater Water Cloud output fields ......................................................................................16
Introduction
As part of our growing support of divers, this feature is a way for users to export their dive logs to custom PDF templates using Shearwater Cloud.
To work with custom PDF templates, you will need a PDF Form editor and a PDF Editor. The Form editor is to create or edit existing form fields, which are used as the output targets for data. The PDF Editor is needed to do any visual aspects such as labels, images, borders, etc. For these instructions we will be using Adobe Acrobat as our reference.
These instructions are not meant to teach users to use PDF Software tools, but instead focus on the elements of software use to be able to edit/modify or provide guidance to be able to work with Shearwater Cloud's PDF export process.

New PDF Export Navigation
With the release of Shearwater Cloud 2.9.6 we added more options to the "Print to PDF" dialog. The first addition is the ability to choose the exported data font. This will only affect the form fields to the specified font. This will not affect any of the labels in the PDF. Another feature is the Save Export Report. This will save any print information about the PDF process in order to help identify any issues printing to custom PDFs.
If selecting multiple dives, the "Print to PDF" dialog will also show the option to save a number of dives per file. Options provided are 1, 5, 10, 25, 50 and 100.
Custom PDF Options
Custom PDF options can be accessed by selecting Custom Template from the Template dropdown selection.

Once selected, additional options will appear in the Print to PDF dialog.
Select Custom Template This option will open a file browser to select the PDF template to be used. The path "/" underneath will refer to the file name and one directory level above to assist in indicating what is the current file to use along with a folder name for reference. Custom Template Help Clicking on this option will expand to show additional support options.

Custom Template Instructions is a link to our website where these instructions are posted. Export Default Templates will export the default PDFs that the application uses for templates other than Custom Templates. These can be modified for your own personal use or used as an example for making your own.
Modifying existing PDFs
Click on the "Export Default Templates" and save it to an easy to access folder location. Once a folder is selected, the PDF template files will be saved to the folder.
Form Editing Using a PDF Form Editor, select the Form editor for the software. For the rest of our example, we will be using Adobe Acrobat for reference.
Once the Form is open it will look like this when in Form Editing mode. While in the Form edit mode, we are unable to modify any of the visual aspects of the PDF.

The Form fields are what are editable. These are identified with the black block with the field name. This is a close-up for "location".
A form can be selected and modified with the Form Select tool, which is the cursor arrow icon.
The Form editor allows for changing the form name as well as dimensions. In our example we will demonstrating a simple layout change. In the image below, we reduced the size of the graph and moved the "dive_notes" form field next to it.

If we printed at this point, we would see the notes next to the graph without any border.
Form Property box Forms fields have properties. To access these properties in Adobe Acrobat double click the form field. The properties information can be used to adjust various values or change names. Options are to rename the name for the export data reference, multi/single line, alignment, font size, etc. Shearwater Cloud export does not use all the options available but does work with the basics.

PDF Edit
With PDF Editing mode features we can change, add, or remove any existing visual parts of the PDF such as any labels or images. This can be helpful in situations to translate the labels from the default English to another language.
Switch to the Edit PDF mode to adjust any of the visual parts of the template.
Below, we moved the Graph beside the Dive Notes: label and border. We provided a picture of the size anchors as well as the Form example of the moved items.

Here is the Template PDF saved and opened by a PDF viewer.
We can now use this template in the Shearwater Cloud PDF print "Select Custom Template" option.

* In our sample we did not rename the file, but feel free to name the PDF template to fit your use case.
Here is the modified output once printed.
* This is a computer-generated factory test dive and does not reflect any diving suggestions.

Creating a Custom Template from scratch
What if you want to make your own PDF template from scratch? These instructions will guide you in making your own PDF template. PDF Form Editing To start you will need to create a new PDF.
Create New for a new file and start the process. This process may be different based on the software used. We will again demonstrate with Adobe Acrobat.
Use the Add Text Field Button to create a new Form field.
Click on the canvas to generate the new Form field anywhere you want for your use and design aesthetics.
Once the field is created, use the properties box to edit the name. Double click the text box to edit the name.

To be filled out by Shearwater Cloud, a Form field must have a name that Shearwater Cloud will recognize. The list of specific field names can be found at the bottom of this instruction document. For our sample here we will use "dive_number".
Below is a sample of the available form field information that is filled out by Shearwater Cloud and a sample of what the printout will look like.

This is what our custom form will print out using the above template:.
PDF Edit visual parts It is useful to add labels and images to help with information presentation. The Edit PDF will have the ability to Add Text or Images. For our demo pdf we will add a few labels and a simple border to the main blocks. Feel free to be as detailed or minimalistic as possible to your design.

In this sample we added some labels and some big pink borders for the areas we used.
*This design is perhaps a bit garish, isn't it?
Once we use this version to print out a dive, here are the results.

This information is enough to be able to create any PDF export template you would like to make. The NDL is the limit now.

Technical Information for Form Fields
This section covers the technical information for the Form Fields.

Shearwater Cloud Output Fields Here are the form names for form fields Shearwater Cloud uses to assign the correct information to the field. These names must be exact for the export reference to work.

Form name dive_number Date Location Site weather_image weather conditions_image conditions environment_image environment platform_image platform dive_graph mode deco_model conservatism end_surface_gf dress_image dress apparatus_image apparatus buddy time visibility air_temp avg_temp weight

Type text text text text image text image text image text image text text text text text text text text text text text text text text text text

Description of information Dive number Date of the dive Location of the dive Site of the dive Image of the selected drop down. Name of the selected dropdown Image of the selected drop down. Name of the selected dropdown Image of the selected drop down. Name of the selected dropdown Image of the selected drop down. Name of the selected dropdown Rendered graph of the dive The Dive mode Deco model selected Conservatism values GF of the end of the dive Image of the selected drop down. Name of the selected dropdown Image of the selected drop down. Name of the selected dropdown Information from the Buddy field Time of the dive Information from the Visibility field Temperature taken when the dive started Average calculated temperature by the Dive Computer Weight from the Gear information

serial_number dive_computer_image tank1_average_sac tank1_end_pressure tank1_start_pressure tank1_name tank2_average_sac tank2_end_pressure tank2_start_pressure tank2_name tank3_average_sac tank3_end_pressure tank3_start_pressure tank3_name tank4_average_sac tank4_end_pressure tank4_start_pressure tank4_name
dive_notes

text image text
text
text text text
text
text text text
text
text text text
text
text text

Dive computer serial number
Image to be rendered for the Shearwater Dive Computer
Tank average calculated sac Tank end pressure either from the Dive Computer or entered field Tank start pressure either from the Dive Computer or entered field
Name of the tank entered on the Dive Computer Tank average calculated sac Tank end pressure either from the Dive Computer or entered field Tank start pressure either from the Dive Computer or entered field
Name of the tank entered on the Dive Computer
Tank average calculated sac Tank end pressure either from the Dive Computer or entered field Tank start pressure either from the Dive Computer or entered field Name of the tank entered on the Dive Computer
Tank average calculated sac Tank end pressure either from the Dive Computer or entered field Tank start pressure either from the Dive Computer or entered field Name of the tank entered on the Dive Computer Collection of all the dives notes to a single field output. This will be lowered to a minimal font size of 6 to try and fit as much as possible. If the text does not fit, it will leak outside of the render clipping range.

text Ensure Multiline is enabled in the form field properties.


PDFium PDFium