LeafLabs Garden

A place to share, learn, and grow...

1. 

   StephenFromNYC
   Moderator

   August 24, 2010

   Hello,

   I am using Maple IDE 0.0.6 on a Pentium III Thinkpad (512 meg RAM) running Windows XP Professional SP3.

   Thank you Poslathian (http://forums.leaflabs.com/topic.php?id=128) for telling me about the file http://leaflabs.com/docs/maple-bootloader/

   This HTML file is not included in the Maple IDE 0.0.6 zip archive (for Windows).

   Another HTML file which is not included in the 0.0.6 zip archive is http://leaflabs.com/docs/maple/timers

   It is possible these HTML files were create after the 0.0.6 archive was created.

   I think the files in IDE 0.0.6 are dated 07/22/2010 and 07/29/2010.

   Is there a list of HTML files which were updated since 0.0.6 was released or a zip file which contains the most recent versions of each HTML file?

   Thanks!

   Stephen from NYC

   Posted 5 years ago #
2. 

   bnewbold
   Ex-Leaflabs

   The Timers page not being included in the windows and OSX v0.0.6 release was a mistake:
   http://github.com/leaflabs/maple-ide/commit/0ee9b4978540b63a3265b2e30b3ec639893f13df

   The bootloader documentation is part of the website and not in the release docs. It should be rewritten and then included in either the IDE release docs or the bootloader repository.

   Posted 5 years ago #
3. 

   bnewbold
   Ex-Leaflabs

   Oh, and to the last point, you can view a list of changes to the "reference" directory of the IDE at: http://github.com/leaflabs/maple-ide/commits/master/build/shared/reference

   These files get mirrored to the website on a regular basis (usually after any change).

   Posted 5 years ago #
4. 

   StephenFromNYC
   Moderator

   August 26, 2010

   Hello,

   Thanks, bnewbold, for the link to the repository which shows when changes to the Maple documentation are checked in.

   I wish I were qualified to patch bugs in the Maple software, but I think my current software contribution will be limited to creating reproducible bugs, finding inconsistencies in the IDE, and suggesting changes to the documentation.

   Knowing when the documentation changes are made will help me coordinate my contributions.

   Here is a list of corrections (based on 2010-08-25 changes) I found in the current documentation:

   <start of corrections>

   Question/suggestion: is there a "site map" on the LeafLab web site?

   http://leaflabs.com/docs/maple-ide/

   1) (caps) targeting arduino boards -> targeting Arduino boards
   2) (caps) Codesourcery -> CodeSourcery
   3) (space required) Targeted boards:Maple -> Targeted boards: Maple
   4)

   http://leaflabs.com/docs/maple-ide/installation/

   1) (caps) Codesourcery -> CodeSourcery
   2) (caps) into the usb port -> into the USB port
   3) (caps) point windows to -> point Windows to
   4)

   http://leaflabs.com/docs/libmaple/unix-toolchain/

   1) (caps) cygwin -> Cygwin
   2) (caps) python -> Python
   3) (spelling) debugging isn't intergrated -> debugging isn't integrated
   4)

   http://leaflabs.com/docs/maple/

   1) (extra chars) ooooGetting Started with the Maple
   2)

   http://leaflabs.com/docs/maple/errata/

   1) (spelling) immpedence -> impedance
   2)

   http://leaflabs.com/docs/maple/troubleshooting/

   1) (spelling) throbing -> throbbing
   2)

   http://leaflabs.com/docs/maple/compatibility/

   1) (spelling) compatability -> compatibility
   2) (spelling) sacraficing -> sacrificing
   3) (spelling) peristant -> persistant
   4) (spelling) is not maped -> is not mapped
   5)

   http://leaflabs.com/2010/06/maple-ide-0-0-5/

   1) (spelling) consitent -> consistent
   2) (spelling) shoudl -> should
   3) (spelling) incompatabilities -> incompatibilities
   4) (spelling) plese -> please
   5)

   http://leaflabs.com/2010/07/ide-0-0-6-release-horray/

   1) (spelling) condolances -> condolences
   2)

   http://leaflabs.com/docs/maple/quickstart/

   1) (caps) Codesourcery -> CodeSourcery
   2)

   http://leaflabs.com/docs/

   1) (missing) timers.html
   2)

   http://leaflabs.com/docs/maple/pwm/

   1) (bad link) timer docs links to pwm/timers.html
   2) (typo) 16bit -> 16-bit
   3)

   http://leaflabs.com/docs/maple/usb/

   1) (spelling) recieved - > received
   2)

   http://leaflabs.com/docs/maple/jtag/

   1) (spelling) compatable devices - > compatible devices
   2)

   http://somewhere

   1) micro controller -> microcontroller
   2)

   http://forum.leaflabs.com:

   1) In the third field Tags, it says "comma seperated". The word "seperated" is misspelled (the correct spelling is "separated").
   2)

   <end of corrections>

   Thanks!

   Stephen from NYC

   Posted 5 years ago #
5. 

   bnewbold
   Ex-Leaflabs

   Thanks, I fixed most of these!

   I couldn't find ooooGetting (google "ooooGetting" site:leaflabs.com), cygwin seems to have been removed when we made tweaks for OSX, and I like writing it 16bit and probably do elsewhere.

   The whole site could use a filter with these bash scripts as well:
   http://matt.might.net/articles/shell-scripts-for-passive-voice-weasel-words-duplicates/

   Posted 5 years ago #
6. 

   StephenFromNYC
   Moderator

   September 3, 2010

   Hello-

   Many thanks to bnebold and mbolivar for updating the documentation files. Yes, this is a mindless but very important task.

   Some things, such as 16-bit vs 16bit, I consider "stylistic". If there is no obvious correct or preferred expression I think it is important to be consistent throughout the site. As you know, this is a challenge when a site becomes large or when it is maintained by different group members.

   bnewbold, I found the bash scripts very interesting. I might start using then to filter all my emails and forums posts.

   1) When file names are changed should you keep a "filler" HTML file (with the original name) which has a link (or an autoreferral) to the new file?

   For example, in Google I found a link to:

   http://leaflabs.com/docs/maple/compatability/

   However, the leaflabs web site returns a 404 HTML error.

   2) In the first line of http://leaflabs.com/docs/maple/ I see four strange characters before the words "Getting Started"

   "See the Getting Started with the Maple"

   Thanks again for the work.

   Stephen from NYC

   Posted 5 years ago #
7. 

   bnewbold
   Ex-Leaflabs

   We had a wordpress plugin before that did automatic redirects but it was buggy; I made a bounce page by hand.

   I'm not sure what the characters you are seeing are, probably some encoding issue? I rewrote that sentence which hopefully fixed it.

   I finally found the --mode=html argument to aspell and was able to spell check all the documentation, there were a lot of mispellings (sic)! This doesn't apply to the parts of the website not under version control.

   Posted 5 years ago #
8. 

   bnewbold
   Ex-Leaflabs

   We had a wordpress plugin before that did automatic redirects but it was buggy; I made a bounce page by hand.

   I'm not sure what the characters you are seeing are, probably some encoding issue? I rewrote that sentence which hopefully fixed it.

   I finally found the --mode=html argument to aspell and was able to spell check all the documentation, there were a lot of mispellings (sic)! This doesn't apply to the parts of the website not under version control.

   Posted 5 years ago #

RSS feed for this topic

Reply

You must log in to post.