nikidala
28th January 2004, 07:05 AM
Okay, per your suggestion, I have been putting my template only mods in my HTL to keep track of everything. Came up with a few suggestions / issues in the process...
1) While adding my template only mods, I noticed that there could be some improvement with the code change section (actually, just in regards to one specific type of change)... Currently you have an option for "add before", "add after", and "replace", but in a couple of my changes, I needed to remove the "old code" all together. At first, I just thought, logically I should choose the "replace" and leave the "new code" section blank. Well, the system didn't like that and didn't save it. Did find a work around, though... If I added a blank line ([enter]), the system would accept it and save the data in the mod. Not quite intuitive, but it worked (sort of, continue)...
Okay, so I was hunky-dory and got the majority of my major template only mods in. Awesome, cause I was holding off reverting some of my changed templates (for new versions) until I cataloged everything so I would forget. Reverted the templates, went to the "list all mods" section, pulled up my template mods, and it was functional, but would be confusing if I didn't know what it was doing...
Since the HTL code automatically adds the "[start ...]" and the "[end ...]" to the "new code", I had:
<!-- [start ...] -->
<!-- [end ...] -->
At first, I was like "Well, this is really a hack tracking log, so I should just keep it to myself. It isn't a big deal.", but then I began to think that some hacks may require the removal of some code without adding new code in... So, it could be feasible that this issue may come up. While it isn't a high priority thing, since not so proficient users may be installing the hacks and since file / template edits are done by hand it *may* be confusing to them. Also, since the blank line thing isn't mentioned hackers could get a little miffed if their changes don't submit after entering a "replace" with blank "new code" or even worse, they may not realize it (since the changes are ordered by the name, which rocks, BTW) and would submit the hack without realizing one of the changes wasn't present.
Possible solutions to hacker end:
- Create a "remove" option along with the "add before", "add after", and "replace" options
- Allow a blank "new code" entry (without needing the "fake" line)
- Mention that code removals will need a blank line in the "new code" section to properly submit
Possible solutions to installer end:
- If "new code" text is blank / blank line or option is "remove" (depending on the solution above used), do not display the "new code" section
- If "new code" text is blank / blank line or option is "remove" (depending on the solution above used), instead of using [start] and [end], maybe a [line(s) removed] would be more intuitive
2) HTL --> Edit Hack details --> Hack Version:
A <dfn> stating that the "v" (for version) should not be included. Dummy already fell for that one...
3) HTL --> Edit Hack details --> Difficulty rating to install this hack:
Either a drop down box with options, or a little note in the form of "(i.e. - ...)", would be good. I didn't have a clue if it was supposed to be 1 - 5, 1 - 10, or Easy - Hard. Only after I saw a HTL hack on vb.org did I realize... Yeah, I am slow (but thorough ;))...
4) HELP topics would be WONDERFUL (a la Admin Help / Phrases)... I know you have the Hack Docs here, but hear me out... My idea, compile help topics / help phrases, BUT release them as an add-on to the hack. That way more skilled HTL users, HTL installers only, and people worried about the "massive size that the HTL is corrupting things" ;) will have the option to have a "thin" version. While HTL newbie hackers (i.e. - new to HTL, but not necessarily new to hacking) will have on screen, "topic specific" help if something seems confusing to them. Plus, once the person learns everything, they should just be able to "uninstall" the HTL Help Hack making the HTL Help Hack efficient and helpful.
5) HTL --> List all modifications:
What you have now is cool and rocks, but I had a thought for a slight improvement. Rename the "section" / menu item to "List modifications", then on the first page have (items marked with "(URL Link)" would actually be links, I am not saying make "(URL Link)" a link):
List all modifications (URL Link)
List modifcations by specified hack:
HTL (URL Link)
Hack 2 (URL Link)
etc. (URL Link)
List modifications by specified file / template:
admincp/index.php (URL Link)
adminfunctions_template.php (URL Link)
Modified File 3 (URL Link)
Modified File etc. (URL Link)
Modified Template 1 (URL Link)
Modified Template 2 (URL Link)
Modified Template etc. (URL Link)
As you can hopefully tell by my examples, the file / template section would only list the "modified" files / templates, not all. The thinking on adding the files / templates section is:
- When upgrading, we are often told to "revert" updated templates and "re-update" them with new code. Since there is a list of templates to "revert" to the new versions, you could go through one by one, reverting and easily updating all of the necessary changes (rather than have to peruse through multiple hacks to see which ones apply). This would also help hack authors that would need to go through and update any changed "old code" when the "old code" changes with a new version (or atleast that is what I am thinking).
- Although this hasn't been the case with the beta / gamma / RC versions of vb 3, I have heard that new official "sub" versions tend to list the modified files for the new version, so that the minimal amount of re-hacking and / or FTPing is needed. If this is the case, this would help people in determining if one of the new files has been "hacked" (via the list) and updating any hacked files without having to go through each hack looking for the file. Also, same thing as above applies to hack authors for updating changed "old code" for new versions.
Just a thought, as I had to revert some of my older templates to newer versions, and noticed that while the "list all" does list all mods and does alphabetize the templates / files in each one, they are still "grouped" by the hack. Which rocks, except if you are trying to quickly determine which mods apply to a few specific templates / files and reapply them...
Okie dokie... That is all that I was able to come up with for today... ;) Hope they were either helpful, informative, or a good laugh... :)
1) While adding my template only mods, I noticed that there could be some improvement with the code change section (actually, just in regards to one specific type of change)... Currently you have an option for "add before", "add after", and "replace", but in a couple of my changes, I needed to remove the "old code" all together. At first, I just thought, logically I should choose the "replace" and leave the "new code" section blank. Well, the system didn't like that and didn't save it. Did find a work around, though... If I added a blank line ([enter]), the system would accept it and save the data in the mod. Not quite intuitive, but it worked (sort of, continue)...
Okay, so I was hunky-dory and got the majority of my major template only mods in. Awesome, cause I was holding off reverting some of my changed templates (for new versions) until I cataloged everything so I would forget. Reverted the templates, went to the "list all mods" section, pulled up my template mods, and it was functional, but would be confusing if I didn't know what it was doing...
Since the HTL code automatically adds the "[start ...]" and the "[end ...]" to the "new code", I had:
<!-- [start ...] -->
<!-- [end ...] -->
At first, I was like "Well, this is really a hack tracking log, so I should just keep it to myself. It isn't a big deal.", but then I began to think that some hacks may require the removal of some code without adding new code in... So, it could be feasible that this issue may come up. While it isn't a high priority thing, since not so proficient users may be installing the hacks and since file / template edits are done by hand it *may* be confusing to them. Also, since the blank line thing isn't mentioned hackers could get a little miffed if their changes don't submit after entering a "replace" with blank "new code" or even worse, they may not realize it (since the changes are ordered by the name, which rocks, BTW) and would submit the hack without realizing one of the changes wasn't present.
Possible solutions to hacker end:
- Create a "remove" option along with the "add before", "add after", and "replace" options
- Allow a blank "new code" entry (without needing the "fake" line)
- Mention that code removals will need a blank line in the "new code" section to properly submit
Possible solutions to installer end:
- If "new code" text is blank / blank line or option is "remove" (depending on the solution above used), do not display the "new code" section
- If "new code" text is blank / blank line or option is "remove" (depending on the solution above used), instead of using [start] and [end], maybe a [line(s) removed] would be more intuitive
2) HTL --> Edit Hack details --> Hack Version:
A <dfn> stating that the "v" (for version) should not be included. Dummy already fell for that one...
3) HTL --> Edit Hack details --> Difficulty rating to install this hack:
Either a drop down box with options, or a little note in the form of "(i.e. - ...)", would be good. I didn't have a clue if it was supposed to be 1 - 5, 1 - 10, or Easy - Hard. Only after I saw a HTL hack on vb.org did I realize... Yeah, I am slow (but thorough ;))...
4) HELP topics would be WONDERFUL (a la Admin Help / Phrases)... I know you have the Hack Docs here, but hear me out... My idea, compile help topics / help phrases, BUT release them as an add-on to the hack. That way more skilled HTL users, HTL installers only, and people worried about the "massive size that the HTL is corrupting things" ;) will have the option to have a "thin" version. While HTL newbie hackers (i.e. - new to HTL, but not necessarily new to hacking) will have on screen, "topic specific" help if something seems confusing to them. Plus, once the person learns everything, they should just be able to "uninstall" the HTL Help Hack making the HTL Help Hack efficient and helpful.
5) HTL --> List all modifications:
What you have now is cool and rocks, but I had a thought for a slight improvement. Rename the "section" / menu item to "List modifications", then on the first page have (items marked with "(URL Link)" would actually be links, I am not saying make "(URL Link)" a link):
List all modifications (URL Link)
List modifcations by specified hack:
HTL (URL Link)
Hack 2 (URL Link)
etc. (URL Link)
List modifications by specified file / template:
admincp/index.php (URL Link)
adminfunctions_template.php (URL Link)
Modified File 3 (URL Link)
Modified File etc. (URL Link)
Modified Template 1 (URL Link)
Modified Template 2 (URL Link)
Modified Template etc. (URL Link)
As you can hopefully tell by my examples, the file / template section would only list the "modified" files / templates, not all. The thinking on adding the files / templates section is:
- When upgrading, we are often told to "revert" updated templates and "re-update" them with new code. Since there is a list of templates to "revert" to the new versions, you could go through one by one, reverting and easily updating all of the necessary changes (rather than have to peruse through multiple hacks to see which ones apply). This would also help hack authors that would need to go through and update any changed "old code" when the "old code" changes with a new version (or atleast that is what I am thinking).
- Although this hasn't been the case with the beta / gamma / RC versions of vb 3, I have heard that new official "sub" versions tend to list the modified files for the new version, so that the minimal amount of re-hacking and / or FTPing is needed. If this is the case, this would help people in determining if one of the new files has been "hacked" (via the list) and updating any hacked files without having to go through each hack looking for the file. Also, same thing as above applies to hack authors for updating changed "old code" for new versions.
Just a thought, as I had to revert some of my older templates to newer versions, and noticed that while the "list all" does list all mods and does alphabetize the templates / files in each one, they are still "grouped" by the hack. Which rocks, except if you are trying to quickly determine which mods apply to a few specific templates / files and reapply them...
Okie dokie... That is all that I was able to come up with for today... ;) Hope they were either helpful, informative, or a good laugh... :)