Wiki cleanup / reorganization with new release strategy - page 2 - CHDK Releases - CHDK Forum  
« previous next »
Pages: 1 [2] 3   Go Down

Wiki cleanup / reorganization with new release strategy

  • 22 Replies
  • 7618 Views
*

Offline outslider

  • *****
  • 761
Re: Wiki cleanup / reorganization with new release strategy
« Reply #10 on: 12 / February / 2012, 14:37:23 »
Advertisements
I'm open to discussion, and I have asked about that a few months ago, when I've started that ;)

http://chdk.setepontos.com/index.php?topic=2905.msg78600#msg78600

There was no responses, so I just started. Of course if there is other idea how to organize whole this stuff, then particular command descriptions can be just Ctl+C/Ctrl+V'ed from here. My goal is to just give good explanations for commands :)
Logged
if (2*b || !2*b) {
    cout<<question
}

Compile error: poor Yorick
*

Offline reyalp

  • ******
  • 13291
Re: Wiki cleanup / reorganization with new release strategy
« Reply #11 on: 12 / February / 2012, 14:40:10 »
For the script section, I'm strongly in favor of breaking it up into multiple pages to cover related scripts commands.  Even with a very brief description, it's really just too big and unwieldy and some of the functions really need more than a one line description.

My thoughts:
Script Reference: Index of all the reference pages. Might be able to do something with categories. It would be nice if you could index each command name.
Script Reference/
 Keyboard functions: contains is_key, wait_click, press etc
 Exposure control functions: get/set*96 etc
 Camera characteristics: get_buildinfo, get_propset etc
...
It's fairly easy to move content around, so it's totally fine to clean up the content before we've settled on the final structure.

Outside of the reference, it would be good to have a some pages which go into more of a big picture of how scripts run, e.g. the get_shooting loop, how sleep/yield/wait functions interact with the system etc, when you should call the exposure control functions, when you should use propcases directly...
Logged
Don't forget what the H stands for.
*

Offline waterwingz

  • ******
  • 12083
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #12 on: 12 / February / 2012, 22:55:34 »
Seems like the key might be a really good "overview" page that then links to all the components ?   If the stuff I'm working on for the SD card rewrite does not suck too badly then I'll take a whack at that and then everyone can "dog pile" on to make it great ?
« Last Edit: 12 / February / 2012, 22:57:39 by waterwingz »
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline waterwingz

  • ******
  • 12083
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #13 on: 25 / February / 2012, 16:41:25 »
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline reyalp

  • ******
  • 13291
Re: Wiki cleanup / reorganization with new release strategy
« Reply #14 on: 25 / February / 2012, 17:13:26 »
Looks like a big improvement.

Some comments. Might want to emphasize a little more that "firmware update" is not actually a firmware update. You do imply this with the "must be done each time" part, but I think it's worth stating explicitly, in bold ;)

"Start your camera in Play Mode by pressing the Play button"
Some cameras have a hard switch not a play button, in which case you set that to play, and start with the regular power button.

Quote
This means that for cameras released prior to Jan 2011 there need to be a FAT16 partition with a slightly modified boot block and for cameras released after Jan2011 there needs to be a FAT32 partition with different modifications to the boot block.
2011 cameras can still boot from FAT16 cards. You mention this in the table/text below, but the iniital paragraph seems to imply they *must* use FAT32

Also on the title of the section, we've previously called this the "bootable SD card" method. Not sure if "sd card lock" method is better. Don't really care.

I'd also mention somewhere that (in the paragraph with "Note that your SD card needs to be "bootable" ") that this is NOT the bootable setting you can set with normal disk utilities, since it's fairly common for people to skim and then complain "but I set it bootable in gparted!"

Thanks for doing this  :)
Logged
Don't forget what the H stands for.
*

Offline waterwingz

  • ******
  • 12083
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #15 on: 25 / February / 2012, 17:49:48 »
Quote from: reyalp on 25 / February / 2012, 17:13:26
Thanks for doing this  :)
Always more fun when you get some feedback. 

I'll make the changes and maybe PM Fe50 to see what he thinks ?
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline zeno

  • *****
  • 889
Re: Wiki cleanup / reorganization with new release strategy
« Reply #16 on: 26 / February / 2012, 06:59:17 »
@waterwingz

sorry to do this to you after all your hard work, but I've just upgraded my SDMInst Mac app to support making FAT32 cards bootable (with an appropriate warning about this applying to post January 2011 cameras only). Perhaps you could modify the "Putting CHDKD onto an SD Card" entry to reflect this?

For details of the latest SDMInst - see http://www.zenoshrdlu.com/clickpansdm/sdminst.html

Logged
A570, S100, Ixus 127
Author of ASSIST, STICK, WASP, ACID, SDMInst, LICKS, WICKS, MacBoot, UBDB, CFGEdit
*

Offline waterwingz

  • ******
  • 12083
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #17 on: 26 / February / 2012, 09:52:17 »
Quote from: zeno on 26 / February / 2012, 06:59:17
sorry to do this to you after all your hard work, but I've just upgraded my SDMInst Mac app to support making FAT32 cards bootable (with an appropriate warning about this applying to post January 2011 cameras only). Perhaps you could modify the "Putting CHDKD onto an SD Card" entry to reflect this?
Great new - no apology necessary!

I should have anticipated this when I did the first draft of the new page, but just getting everything organized was a real challenge.  There are so many possible permutations - I woke up this morning thinking of a couple of other methods.   Never mind what happens if CardTricks and LICKS get upgraded too.   

Right now the biggest problem will be probably be people trying ports for new cameras that don't make the ps.fi2 file available during the porting process.


Update : links for Apple FAT32 sdminste.exe and Linux FAT32 LICKS programs added to wiki page.
« Last Edit: 02 / March / 2012, 17:31:02 by waterwingz »
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline waterwingz

  • ******
  • 12083
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #18 on: 02 / March / 2012, 17:59:03 »
Quote from: reyalp on 12 / February / 2012, 14:40:10
For the script section, I'm strongly in favor of breaking it up into multiple pages to cover related scripts commands.  Even with a very brief description, it's really just too big and unwieldy and some of the functions really need more than a one line description.

My thoughts:
Script Reference: Index of all the reference pages. Might be able to do something with categories. It would be nice if you could index each command name.
Script Reference/
 Keyboard functions: contains is_key, wait_click, press etc
 Exposure control functions: get/set*96 etc
 Camera characteristics: get_buildinfo, get_propset etc
...
It's fairly easy to move content around, so it's totally fine to clean up the content before we've settled on the final structure.

Outside of the reference, it would be good to have a some pages which go into more of a big picture of how scripts run, e.g. the get_shooting loop, how sleep/yield/wait functions interact with the system etc, when you should call the exposure control functions, when you should use propcases directly...
Right now,  I'd settle for :

uBASIC
1) An overview page of general stuff that also includes links to the two reference pages listed next,  links to the various "how to program" pages on the wiki or external, links to any "fancy stuff" pages like those that reyalp lists above,  and links to the various pages of specific scripts.
2) A reference page that describes uBASIC syntax and standard language operators for assignment, flow control, conditionals etc.
3) A reference page that lists every CHDK uBASIC command with a brief example. Might need to be an index page pointing to subpages broken out by functional area but for searching reasons I'm not sure I like that idea.

LUA
1)  An overview page of general stuff that also includes links to the two reference pages listed next   links to the various "how to program in Lua" pages and external web sites,  links to any "fancy stuff" pages like those that reyalp lists above, and links to the various pages of specific scripts.
2) A reference page that describes Lua syntax and standard language operators for assignment, flow control, conditionals etc.
3) A reference page that lists every CHDK Lua command with a brief example. Might need to be an index page pointing to subpages broken out by functional area but for searching reasons I'm not sure I like that idea.

I think that the first two pages listed for either language could be culled from this list :

http://chdk.wikia.com/wiki/Scripts
http://chdk.wikia.com/wiki/CHDK_scripting
http://chdk.wikia.com/wiki/Script_commands
http://chdk.wikia.com/wiki/Script_commands_stub

http://chdk.wikia.com/wiki/UBASIC
http://chdk.wikia.com/wiki/UBASIC/uBASIC_syntax
http://chdk.wikia.com/index.php?title=UBASIC/TutorialScratchpad&s=wl
http://chdk.wikia.com/wiki/UBASIC/Scripts
http://chdk.wikia.com/wiki/UBASIC/Scripts

http://chdk.wikia.com/wiki/Lua
http://chdk.wikia.com/wiki/Lua/Drawings
http://chdk.wikia.com/wiki/Lua/Lua_syntax
http://chdk.wikia.com/wiki/Lua/Lua_Reference
http://chdk.wikia.com/wiki/Lua/Lua_Reference
http://chdk.wikia.com/wiki/Lua/PTP_Scripting

Then the third page (the actual functions) gets derived from the source code in the svn.

Having just finished the update to the SD Card page, I have a pretty good idea how much work this could be and how to attack it.   My proposal would be to nuke the pages listed above when its done.

« Last Edit: 03 / March / 2012, 09:57:15 by waterwingz »
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline reyalp

  • ******
  • 13291
Re: Wiki cleanup / reorganization with new release strategy
« Reply #19 on: 02 / March / 2012, 23:03:36 »
Quote from: waterwingz on 02 / March / 2012, 17:59:03
LUA
1)  An overview page of general stuff that also includes links to the two reference pages listed next   links to the various "how to program in Lua" pages and external web sites,  links to any "fancy stuff" pages like those that reyalp lists above, and links to the various pages of specific scripts.
2) A reference page that describes uBASIC syntax and standard language operators for assignment, flow control, conditionals etc.
I assume you mean Lua synatax ;) But personally, I feel quite strongly that we should not try document the base Lua language. The official lua documentation is more complete and correct than anything we will write. We should send users there, and concentrate on documenting those areas where CHDK differs. The current http://chdk.wikia.com/wiki/Lua/Lua_syntax is plenty, or possibly more than plenty.
Quote
3) A reference page that lists every CHDK Lua command with a brief example. Might need to be an index page pointing to subpages broken out by functional area but for searching reasons I'm not sure I like that idea.
One difficulty here is that there is a 90% or more overlap between ubasic and lua CHDK functions. Duplicating them will significantly increase the maintenance overhead. Because of this, I'd lean to having a "script API reference" with language specifics where needed.
Logged
Don't forget what the H stands for.
Pages: 1 [2] 3   Go Up
« previous next »
 

Related Topics