|
|
| Line 1: |
Line 1: |
| − | __NOTOC__
| + | #REDIRECT [[JNOTES - Get job detailed notes (Unit Workshop Report Generator function)]] |
| − | == Syntax ==
| |
| − | '''$JNOTES'''{job no., line, text/flag, search|1/2/3, output opt}
| |
| − | | |
| − | == Description ==
| |
| − | Returns a line of job detailed notes, or one of the line's print flags.
| |
| − | | |
| − | A {{Menu|Unit Workshop}} job can have detailed notes attached, and each line can be set to print out on one, all, or any combination of quotation, jobcard or invoice. You can use this function to report on the notes for any given job.
| |
| − | | |
| − | | |
| − | == Parameters ==
| |
| − | ;job no.
| |
| − | :A text parameter that can be omitted.
| |
| − | :The job number.
| |
| − | ;line
| |
| − | :A numeric parameter that can be omitted (it defaults to "1").
| |
| − | :;1-999
| |
| − | ::The line number of notes to return.
| |
| − | :;-1--999
| |
| − | ::Can be less than 0 only if search text is being used.
| |
| − | ;text/flag
| |
| − | :A text parameter that can be omitted (it defaults to "T").
| |
| − | :Whether to return the line text or a print flag value.
| |
| − | :;T
| |
| − | ::Will output the text of the line.
| |
| − | :;F
| |
| − | ::Will output the value of the selected print flag.
| |
| − | ;search|1/2/3
| |
| − | :A text or numeric parameter that can be omitted.
| |
| − | :Optional text to search for, or, which print flag to return.
| |
| − | :;search
| |
| − | ::Search for the line'th occurrence. If line is less than 0 then search for the line'th occurrence backwards from the end of the notes.
| |
| − | {{Tip|text=
| |
| − | The case of letters does not matter, i.e. searching for "BOB" will find lines containing "BOB", "bob", or "Bob".
| |
| − | }}
| |
| − | | |
| − | :;1/2/3
| |
| − | ::Return the Jobcard (1), Invoice (2) or Quote (3) print flags.
| |
| − | ;output opt
| |
| − | :A text parameter that can be omitted (it defaults to "T").
| |
| − | :Output option when search text has been used.
| |
| − | :;T
| |
| − | ::Will output the text of the line where the search line was found.
| |
| − | :;L
| |
| − | ::Will output the line number where the search text was found.
| |
| − | | |
| − | == Returns ==
| |
| − | A text or numeric (depending on the parameters) value.
| |
| − | The text contained within the line'th line of detailed notes, or the line'th line of detailed notes that contains the specified search text (if there is one), or the number of the line the text was found on, from the detailed notes for the ( job no.) supplied.
| |
| − | | |
| − | Alternatively may return one of the three possible print flags for the given line of detailed notes, which indicate whether the current line should be printed on the Quotation, Jobcard or Invoice.
| |
| − | | |
| − | | |
| − | [[Category:Unit Workshop Report Generator functions]]
| |
