Overview of PeopleCode Developer's GuideThis preface provides an overview of the PeopleCode Developer's Guide and lists typographical conventions used in PeopleCode.
Overview of PeopleCode Developer's GuideThis PeopleBook covers the concepts of PeopleCode, the programming language used in the development of Oracle's PeopleSoft applications. Its chapters describe techniques for adding PeopleCode to applications, tips for using PeopleCode, the interaction of PeopleCode and the Component Processor, and a number of other specialized topics, such as the use of the PeopleCode debugger and referencing data in the component buffer.
The accompanying books, the PeopleCode API Reference and the PeopleCode Language Reference, contain the reference material for the PeopleCode language. The chapters in these books describe the syntax and fundamental elements of the PeopleCode language.
PeopleBooks and the Online PeopleSoft Library contains general product line information, such as related documentation, common page elements, and typographical conventions.
PeopleCode Typographical Conventions
Throughout this book, we use typographical conventions to distinguish between different elements of the PeopleCode language, such as bold to indicate function names, italics for arguments, and so on.
This table describes the typographical conventions used in PeopleCode:
|
Font Type |
Description |
|
Indicates a PeopleCode program or other example. |
|
In PeopleCode syntax, keyword entries indicate function names, method names, language constructs, and PeopleCode reserved words that must be included literally in the function call. |
|
|
Variable |
In PeopleCode syntax, items in variable font are placeholders for arguments that your program must supply. |
|
... |
In PeopleCode syntax, ellipses indicate that the preceding item or series can be repeated any number of times. |
|
{Option1|Option2} |
In PeopleCode syntax, when multiple options are available, they are enclosed in curly braces and separated by a pipe. |
|
[ ] |
In PeopleCode syntax, optional items are enclosed in square brackets. |
|
&Parameter |
In PeopleCode syntax, an ampersand before a parameter indicates that the parameter is an already instantiated object. |
PeopleBooks and the PeopleSoft Online LibraryA companion PeopleBook called PeopleBooks and the PeopleSoft Online Library contains general information, including:
Understanding the PeopleSoft online library and related documentation.
How to send PeopleSoft documentation comments and suggestions to Oracle.
How to access hosted PeopleBooks, downloadable HTML PeopleBooks, and downloadable PDF PeopleBooks as well as documentation updates.
Understanding PeopleBook structure.
Typographical conventions and visual cues used in PeopleBooks.
ISO country codes and currency codes.
PeopleBooks that are common across multiple applications.
Common elements used in PeopleBooks.
Navigating the PeopleBooks interface and searching the PeopleSoft online library.
Displaying and printing screen shots and graphics in PeopleBooks.
How to manage the locally installed PeopleSoft online library, including web site folders.
Understanding documentation integration and how to integrate customized documentation into the library.
Application abbreviations found in application fields.
You can find PeopleBooks and the PeopleSoft Online Library in the online PeopleBooks Library for your PeopleTools release.