CHDK Wiki
No edit summary
(typo correction)
Line 30: Line 30:
 
----
 
----
   
==Information for contributers==
+
==Information for contributors==
   
 
Please add your debugged and tested scripts to this section. Reserve discussion and help for writing your script to the {{tpl|DISCUSSION}} section (tab above). Final scripts will appear on this page.
 
Please add your debugged and tested scripts to this section. Reserve discussion and help for writing your script to the {{tpl|DISCUSSION}} section (tab above). Final scripts will appear on this page.

Revision as of 16:22, 24 July 2007

User-written Scripts

Scripts



Information for contributors

Please add your debugged and tested scripts to this section. Reserve discussion and help for writing your script to the DISCUSSION section (tab above). Final scripts will appear on this page.

Scripts added here should include:
  • Camera model that you wrote it on.
  • Other camera models that it is known to work on.
  • Any special instructions that may be required for running the script.
  • Your script!
Since some scripts require special instructions that might be too lengthy to write into the script itself with "print" statements, I think it would be a good idea to start a common practice of including a short but informative text-file with each script, that could be saved by the same filename. Using a .TXT extension so the file may be referred to as a help-file using CHDK's "File Reader".
It has been found that some people are irresponsibly/foolishly sharing collections of scripts without the important accompanying documentation for each script. Try to include some extra info in the header of your script in the form of rem statements that might help the unfortunate people that might get hold of undocumented scripts. Beginning of script example:
rem Author: Your Alias/Name
rem For S-Series ONLY!
rem Use with caution! Read documentation!

To post your own script to this main Scripts page:

  1. Click on the EDIT TAB at the top of the page (not the ones beside each entry).
  2. Scroll to the bottom of the list of scripts.
  3. Add new line
    * [[uBASIC/Scripts: <<YOUR SCRIPT TITLE>>|<<YOUR SCRIPT TITLE>>]]
    to the list.
  4. Save changes.
  5. Click on the list item you just added.
  6. Use the following template to publish your script:
== <<SCRIPT TITLE>> ==

:'''Written for/on:''' <<CAMERA MODEL>>
:'''Also works on:''' <<CAMERA MODELS>>

<<SCRIPT DESCRIPTION>>

'''Documentation/Help''' (save as a small "<<script_filename>>.txt" file to your /CHDK/SCRIPTS/ folder)

----
<<HELP TEXT>>
----

'''Script Code''' (save as "<<script_filename>>.bas" to your /CHDK/SCRIPTS/ folder)

<pre>
<<SCRIPT BODY>>
</pre>

--~~~
[[Category:CHDK|Scripts: {{PAGENAME}}]]