Difference between revisions of "WorldVistA KIDS Guidelines"
From VistApedia
DavidWhitten (talk | contribs) |
DavidWhitten (talk | contribs) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
These Guidelines document the current practice of WorldVistA as of November 2019. | These Guidelines document the current practice of WorldVistA as of November 2019. | ||
| − | When | + | When updating Routines for a KIDS Build, the following actions must be done: |
| + | |||
| + | Changing the second line (Fifth (5) semicolon piece inside stars) of the routine to include the words "WVEHR" and "LOCAL". | ||
| + | This Unix command will display those lines: | ||
| + | |||
| + | cd <directory with .m files> ; for f in *.m; do head f | fgrep -Hin 'WVEHR' ; done | ||
| + | |||
| + | |||
| + | |||
| + | There may be more than one place where the code must be changed to implement the KIDS change. The following actions must be done for each place the changes are done. Also notice the issue with dotted lines below. | ||
| − | |||
# Before the change (and before the ;was; line mentioned next), there should be one or more comment lines marking the block of code that is changed. It is suggested they only be single semicolon comments. | # Before the change (and before the ;was; line mentioned next), there should be one or more comment lines marking the block of code that is changed. It is suggested they only be single semicolon comments. | ||
## This must include the phrase "BEGIN WorldVistA Change" | ## This must include the phrase "BEGIN WorldVistA Change" | ||
| Line 19: | Line 27: | ||
# Finally there should be a line which has the phrase "END WorldVistA Change". Including the date, initials, and reason for the change are useful in this comment block, but not required. | # Finally there should be a line which has the phrase "END WorldVistA Change". Including the date, initials, and reason for the change are useful in this comment block, but not required. | ||
| − | + | Please use care in placing the above block of comments and code. If the line being changed includes dotted (".") lines, the proper number of dots should be placed BEFORE the text mentioned above on each of the lines being inserted. Failure to do this can cause working code to malfunction. | |
| − | Please use care in placing the above block of comments and code. If the line being changed includes dotted (".") lines, the proper number of dots should be placed | ||
Latest revision as of 21:39, 18 December 2019
WorldVistA KIDS Guidelines
These Guidelines document the current practice of WorldVistA as of November 2019.
When updating Routines for a KIDS Build, the following actions must be done:
Changing the second line (Fifth (5) semicolon piece inside stars) of the routine to include the words "WVEHR" and "LOCAL". This Unix command will display those lines:
cd <directory with .m files> ; for f in *.m; do head f | fgrep -Hin 'WVEHR' ; done
There may be more than one place where the code must be changed to implement the KIDS change. The following actions must be done for each place the changes are done. Also notice the issue with dotted lines below.
- Before the change (and before the ;was; line mentioned next), there should be one or more comment lines marking the block of code that is changed. It is suggested they only be single semicolon comments.
- This must include the phrase "BEGIN WorldVistA Change"
- The date of the change should be included
- The initials of the person involved should be included, with the organization
- For example: David J Whitten working for WorldVistA would include "DJW/WV"
- It is best if the reason for the change is stated
- Commenting out the old code with the prefix " ;was;" in front of the line.
- Note that this means the second semicolon is usually followed by a space (" ") unless it had a label, and in the case of a label on the line, the beginning of the text of the label starts immediately after the second semicolon.
- The new line will never have a label, so any change to a line with a label must re-introduce a line with the label.
- The single semicolon is used at the beginning of the line because these comments don't need to be copied over to the run-time representation of the code, which some people call the "object" code.
- Next should be the lines of changed code
- Finally there should be a line which has the phrase "END WorldVistA Change". Including the date, initials, and reason for the change are useful in this comment block, but not required.
Please use care in placing the above block of comments and code. If the line being changed includes dotted (".") lines, the proper number of dots should be placed BEFORE the text mentioned above on each of the lines being inserted. Failure to do this can cause working code to malfunction.
