Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Section


HTML Comment
hiddentrue

REMEMBER! A template can not currently be reapplied. If you want to start over, you'll need to create a new page. Not everything in this template will be used for every API page, it's meant to be a quick format setup. Content can be added and removed as needed after filling out what you want of the form and clicking 'Next', which takes you to the editor. Be aware of where you are putting the page! If you put it in the wrong place, you can go to http://www.profoundlogic.com/docs/pages/listpages-dirview.action?key=PUI and drag'n'drop it at the proper place in the tree. Some of the columns have odd widths, widths are just suggestions in confluence for some reason. If two columns have the same width, they will take up equal-ish space. Any questions on how to use a template, feel free to ask Megan. All HTML notes can be deleted or changed as needed. Everything can be copied and pasted as needed. EXAMPLE OF FINISHED PAGE: pjs.query()


Column
width60%

API Overview

The printerFile.open() API is used to manually open a printer file defined with pjs.definePrinter().

Note
 Printer files are automatically opened at the start of the program or function unless the 'userOpen' file configuration option is used.

RPG Equivalent

OPEN


Column
width40%

Contents

Info
iconfalse
Table of Contents
maxLevel6
minLevel2
indent15px
stylenone
separatorbraces


HTML Comment
hiddentrue

This column is for a table of contents or notice. If neither are needed, delete this column. If only one is needed, delete the other. If more are needed, you can add what you like, remember to check how long it becomes by clicking "Preview" in the bottom right corner. While preview, the page should be checked at half page and maximize to check that the formatting is not distorted. You may need to make some adjustments to compensate. An example of good Table of Contents usage is the pjs.query page.




Section


Column
width25%

Exception Handling

An Error instance with the following properties will be thrown if any problems occur while opening the file:

  • message - The IBM i message text.
  • error - The message id.
  • help - The message help text.


...