RAPID/Help/Best Practices/Adding Best Practice Templates and Examples

Jump to: navigation, search

RAPID

Regulatory and Permitting Information Desktop Toolkit


Best Practices Help: Adding Best Practice Templates and Examples

Help-48.png This page covers adding templates and examples in the Best Practices Form.

Adding Templates

The Add Templates field in the Best Practices Form allows users to enter a link or file for a blank template that others may use when implementing a best practice.

Options for adding templates include:
  1. Link to File
  2. Upload PDF
  3. Upload Image
  4. None

Link to File

This option provides a free form text field, in which the user can add text and/or links to the templates. Ideally, when using this option the link provided will navigate users to a best practice template that has been added to the OpenEI Datasets section. For more help with uploading these type of files, visit the Help:Uploading Files page. Links may also include external links to other websites.

Upload PDF

This option provides an upload option to add a new file. Click the Upload file link below the form field to upload a new document. If the PDF already exists on OpenEI, the name of the file page can be typed in the form text field. If a PDF has been added to existing best practice pages, the form text field will hold the name of that file.

Upload Image

This option provides an upload option to add a new file. Permitted file types are: png, gif, jpg, jpeg, pdf. Click the Upload file link below the form field to upload a new document. If the image file already exists on OpenEI, the name of the file page can be typed in the form text field. If an image has been added to existing best practice pages, the form text field will hold the name of that file.

None

This is the default option if no template has been specified. Leave blank for new best practices that do not have available templates. If editing an existing best practice, selecting this and saving will remove any previous template that was added.


Adding Examples

The Add Examples field in the Best Practices Form allows users to enter a link or file for an existing example that others may use when implementing a best practice.

Options for adding examples include:
  1. Content Field
  2. Link to File
  3. Upload PDF
  4. Upload Image
  5. None

Content Field

There are two fields for adding examples in the Best Practices Form. The first, Add Examples, allows a text description and supporting content for the example to be added. This allows for free text input, that accepts standard wiki or HTML formatting. The second field, Upload/Link Examples, is similar to the options described above for templates, and allows for links to examples (which could also be included in the Add Examples field) or example files to be uploaded.

Link to File

This option provides a free form text field, in which the user can add text and/or links to the examples. Ideally, when using this option the link provided will navigate users to a best practice example document that has been added to the OpenEI Datasets section. For more help with uploading these type of files, visit the Help:Uploading Files page. Links may also include external links to other websites.

Upload PDF

This option provides an upload option to add a new file. Click the Upload file link below the form field to upload a new document. If the PDF already exists on OpenEI, the name of the file page can be typed in the form text field. If a PDF has been added to existing best practice pages, the form text field will hold the name of that file.

Upload Image

This option provides an upload option to add a new file. Permitted file types are: png, gif, jpg, jpeg, pdf. Click the Upload file link below the form field to upload a new document. If the image file already exists on OpenEI, the name of the file page can be typed in the form text field. If an image has been added to existing best practice pages, the form text field will hold the name of that file.

None

This is the default option if no template has been specified. Leave blank for new best practices that do not have available examples. If editing an existing best practice, selecting this and saving will remove any previous example that was uploaded or linked.