19.5.3 SUGGESTING HELPFILE CHANGES
Lusternia's helpfile system is extensive, and as a result maintaining it is a hefty workload. If you've spotted a problem with a helpfile and you're feeling particularly helpful, you can submit a change for the Administration to review. You can also use this to suggest new helpfiles in cases where one is missing. Guidelines For Submission ------------------------- You should bear the following in mind when submitting a helpfile change: - Helpfiles should wrap clientside, and should not include forced wrapping (i.e. a linebreak to artificially create a word wrap). This is not currently the case for all helpfiles and we are endeavouring to move towards it - feel free to remove it should you find it. - You should always check your submissions for smart quotes (Unicode), which cannot be parsed by Lusternia. Never write anything you're going to use in Word or similar, or if you absolutely must ensure you have pasted them into a basic text editor like Notepad++ to remove the smart quotes first. - Hyphens should be used for bullet points. - Helpfiles should never contain ASCII ART or excessive use of delimiters. Using hyphens or equals for lines is acceptable, but nothing more. - Indentations cannot be made using tabs and must be made using spaces. Use sparingly - three spaces are standard. - Clarity is important in helpfiles. Strike a balance between being concise and giving all the relevant information. Commands -------- HELPEDIT is the base command for submitting changes to helpfiles. - HELPEDIT LIST to see your submissions. - HELPEDIT EDIT <filename> to make your edit. - HELPEDIT EDIT NEW to submit a new helpfile. - HELPEDIT VIEW <file> to view a helpfile you edited. - HELPEDIT DIFF <file> to view differences between the original(red) and your edited version(green). - HELPEDIT SUBMIT <file> to submit the helpfile you want changed. - HELPEDIT COMMENT <file> : <comment> to add comments about the changes - HELPEDIT DELETE <file> to remove your edited helpfiles.
