Documentation Standards › Considerations › Standards For Preparing Text Documentation › Presentation Conventions › Control Language Commands in Text

Previous Topic: Presentation Conventions

Next Topic: System Entities in Text
Control Language Commands in Text

Give references to commands, both OS/400 and user-defined, in the following format:

YDSPMNU MENU(FRED) FILE(FREDMENU) +

ALWCMDENT(*NO)

For example:

When quoting examples of CL code in text, always specify the parameter keywords in full, indicate a continuation with a ‘+’ sign, and use bold type for the entire command, For example, LVCHK(*NO), MAXMBRS(*NOMAX), SFLEND, MSGID.

References to parameter keywords should be in upper case and bold type; for example, LVLCHK(*NO), MAXMBRS(*NOMAX), SFLEND, and MSGID.

Use uppercase when referring to the name of an OS/400 object, whether shipped or user-defined; for instance QGPL, QTXT, QPRINT, QBATCH, YINLPGM, YDSPHLP.