APL Wiki
PhraseBook StyleGuidelines
Constraints
Every new code snippet or phrase must be created from the PhraseTemplate. The structure and items defined by the template need to be respected.
Any statement published must be able to run in as many dialects as possible. Exceptions to this rule are allowed but must be stated as such in addition to the main statement.
Almost all remaining "big players" in the market now follow the APL2-syntax. As a result all phrases in this wiki are expected to be APL2-compatible. This means that in Dyalog APL you must assume ⎕ML←3.
Traditionally APL allows a dynamic change of the index origin ⎕IO. Tendency is going towards a ⎕IO of zero. That's what this wiki is doing as well. However, there is nothing wrong with making statements ⎕IO-independent but preferably without reference to ⎕IO itself.
- If a phrase can't be expressed as a single unbroken line then it really isn't a phrase and probably doesn't belong here.
Please use the suggested Naming Conventions for identifiers within the phrase. Longer more descriptive names can and perhaps should be used in examples. We believe the suggested scheme is adequate but if not, consider extending it.
Examples
While the test cases are executed and checked automatically, the examples are not. In other words: the author is fully responsible for the examples. Please act accordingly.
Test Cases
Please see WhyTestCases and TestCasesGuidelines for a full explanation.