- Modify an HTML Definition and check the results.
To satisfy the modification test, I suggest adding a short comment to the end of
PT_COPYURL HTML Definition. If you don't, then you may have to find a different HTML Definition to modify.
document.write("<scr" + "ipt id='jq' " + "src='/scripts/jquery.js'><\/script>");
document.write("<scr" + "ipt id='xxx_ui' " + "src='/scripts/ui.js'><\/script>");
Changing a delivered HTML Definition is considered a modification. Like all modifications, you will need to consider compatibility and upgrade issues. To manage this modification through PeopleTools upgrades and patches, make sure you adequately document your modifications with code comments, project comments, and additional project management documentation. When considering upgrades, your documentation goal is to identify your modification and point the person applying an upgrade to any documentation related to this modification. Because of size limitations, you may not be able to document your entire modification inline. You will, however, be able to point other people at your documentation for this modification. For an effective, short, inline comment, I suggest something like:
<!% BEGIN xxx_1234, 13-DEC-2008, firstname.lastname@example.org -->
Your modified code goes here...
<!% END xxx_1234, 13-DEC-2008, email@example.com -->
With this comment, I have documented the start and end of this modification, the project name of the modification (xxx_1234), the date of the modification (13-DEC-2008), and the developer that made the modification (firstname.lastname@example.org). I have applied several patches over other developers' modified code. Without this type of START/END comment, it is impossible to differentiate between delivered code and modified code. Likewise, sharing a common prefix for all modifications (xxx_ in this case), dramatically simplifies searching for and identifying modifications.
Any time you modify a delivered object, you risk rendering that object unusable. If you modify a delivered PeopleTools object like
PT_PAGESCRIPT, ensure that the delivered code works the same as it did before you modified it.