Shop OBEX P1 Docs P2 Docs Learn Events
My article is going to Nuts and Volts! {updated title} — Parallax Forums

My article is going to Nuts and Volts! {updated title}

MicrocontrolledMicrocontrolled Posts: 2,461
edited 2010-03-17 02:52 in General Discussion
To anyone that feels up to it, here is my article. I have gone over it and edited it, but I would like someone more experienced to go over it for me before it is sent off. Thanks!


Micro

▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
Don't click on this.....

Use the Propeller icon!! Propeller.gif

Post Edited (microcontrolled) : 3/12/2010 11:19:34 PM GMT
«13

Comments

  • davejamesdavejames Posts: 4,047
    edited 2010-03-02 21:13
    Micro - I'd be happy to review your article. What's your time frame? I'd need a couple days to do so.

    What level of review would you want? Meaning, review it from the view of a beginner? Expert?

    Would you wish grammar and structure included?


    I can be *really* "anal"...reviewing documentation is part of what I do at my day-job.

    DJ

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
  • Oldbitcollector (Jeff)Oldbitcollector (Jeff) Posts: 8,091
    edited 2010-03-02 21:19
    I'd kill your column formatting...

    As I understand it, the editors will format your article in columns around whatever other pictures, ads, etc.


    ...reading...

    Edit:

    Initial reaction to it is that you left me wondering how RFID works.

    The difference between an Instructable and a column is the education about the items used,
    in this case, the how RFID works. Do some additional research on what is happening there and add
    it to the beginning of your article. -- All in all, so far so good.

    I'm not an editor so to speak, as I have an author who edits me to make sure I make sense as well.
    I'm sure others will be able to help more in that regard. [noparse]:)[/noparse]



    OBC

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    New to the Propeller?

    Visit the: The Propeller Pages @ Warranty Void.

    Post Edited (Oldbitcollector) : 3/2/2010 9:28:40 PM GMT
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-02 21:53
    Micro,

    Wow, if that is your first attempt at an article I certainly look forward to what else you may write next!

    I can offer a few suggestions in regards to what has worked for me when submitting an article...

    Although your formatting looks great you will want to make it all flow through as a single column like a normal document. The formatting you have (bold type, different font for the command example) is perfect. Just keep the actual article content to text only with minimal formatting. OBC nailed it when mentioning the editors laying out the article will handle formatting of the text since they need to flow it around ads, pictures, etc.

    When I submit an article I will zip it up and add a number to the file name so they can make sure all the parts come through. One zip has the actual article, text, and programs while the other(s) contain the images (jpg, gif, bmp). I'll send extra images so they can pick the most appropriate ones when they layout the article. It's best to let them know it's coming ahead of time.

    The offer that DJ made above sounds good and in my opinion I would prefer someone really look at all the details (grammar, punctuation, etc) since the details can make all the difference. Don't take it as criticism since it is easy to overlook details if you've been staring at it for a while. I've been fortunate enough to have some friends that enjoy proofreading my work before I send it out and it can be invaluable to get another persons perspective.

    You should have the example program code to go with it as a download for their website. As long as people can download the code they can build their own and also follow the listing as they read how it works. Sometimes it makes sense to add more program examples but it really depends on the article and I still need to finish reading it.

    One thing that may help is if you add a BOM (Bill Of Materials) at the end of the article that lists all the part numbers and part sources in one place.

    Looks like you are off to a great start!

    Robert
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-02 22:16
    Thanks for the quick replies! Here is the modifyed version and BOM.
    @davejames: Thanks for the offer! You just tell me what I need to make it acceptable for a magizine.

    Thanks a lot!

    Micro

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....

    Post Edited (microcontrolled) : 3/3/2010 1:14:06 AM GMT
  • Oldbitcollector (Jeff)Oldbitcollector (Jeff) Posts: 8,091
    edited 2010-03-02 22:21
    Better....

    But how does RFID actually work??? :

    Keep going!

    OBC

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    New to the Propeller?

    Visit the: The Propeller Pages @ Warranty Void.
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-02 22:33
    You may not need a lot of detail on how the mysterious RFID tags work but it would be a good idea to add a link at the end of the article to websites that do go into depth about it. That way people who want to learn more about that aspect can do a bit more research. One quick link that came up is:

    http://en.wikipedia.org/wiki/Radio-frequency_identification

    http://www.amazon.com/RFID-Dummies-Patrick-J-Sweeney/dp/076457910X

    I'm sure there are many others...

    Since some people won't know what SPIN is you may want to mention that you were able to accomplish the task using the native built-in SPIN language without the need to get into lower level assembly code. It doesn't seem to mention if you took advantage of multiple cogs. If so then you've leveraged a unique aspect of the Propeller and should mention it.

    Robert
  • CannibalRoboticsCannibalRobotics Posts: 535
    edited 2010-03-02 22:39
    I'm not at a computer with WORD at the moment but I do know N&V will want it submitted in a word format - they will take care of all of the formatting. They will want all of your code, diagrams, figures and photos as separate files.
    When I send them articles I name the graphics files things like "Figure1.jpg" which correspond to the figure name in the text. You'll also want to try to refer to your graphics by name in the text. When they format your article your graphics may be on different pages than the text reference.
    I'm looking forward to reading it!
    Jim-

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Signature space for rent!
    Send $1 to CannibalRobotics.com.
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-02 22:59
    I have modified it in all the suggested fields, but I do not refer to any of the pictures in the text. I will refer to something in the pictures as "as you can see in the pictures" but nothing more specific then that. roll.gif

    Check it out and see what you think!

    Thanks!

    Micro

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....

    Post Edited (microcontrolled) : 3/3/2010 1:13:43 AM GMT
  • LeonLeon Posts: 7,620
    edited 2010-03-02 23:57
    I had a quick look at it. There are many problems with the writing style, and lots of grammatical mistakes, but the N&V editor might sort those out. A typical example is "First, here’s an overview and an introduction to RFID." The following text is in a different order - the introduction to RFID is followed by the overview.

    One major problem is the length of the paragraphs; they are too long, making the article difficult to read.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Leon Heller
    Amateur radio callsign: G1HSM

    Post Edited (Leon) : 3/3/2010 12:08:33 AM GMT
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-03 00:14
    @Leon: Yes, I thought about that. I will edit that in a while. I can make more paragraphs, but they would not have different headers, just be more organized into different paragraphs. Thank you for the help!

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-03 00:19
    There are usually issues with the first drafts of an article so don't get discouraged. It often takes several passes before they shape up.

    The length of the paragraphs shouldn't be too hard to sort out. For the hardware section look for logic places to break it up. For example separate the electronics from the mechanical section.

    Keep on going....

    Robert
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-03 00:22
    OK, thanks. smile.gif I was expecting to have to correct a lot, anyway.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....
  • Phil Pilgrim (PhiPi)Phil Pilgrim (PhiPi) Posts: 23,514
    edited 2010-03-03 00:58
    microcontrolled,

    It's probably not a good idea to post your draft publicly like this. The reason is that most publishers insist on "first publication rights", i.e. they won't accept anything that's already been published. Technically, posting on a public forum counts as a "publication". It would be better just to solicit the proofreading here and email the draft copy, including a copyright notice, to those who are interested.

    -Phil
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-03 01:12
    Thanks, I just removed all the draft copies from the forum.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-03 01:13
    That is a good point and the attachments should probably be removed from this thread. He should still be ok since it is an early draft that will still probably undergo many revisions, and hasn't include any pictures or code yet. Better to take off the attachments to play it safe.

    Robert
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-03 01:21
    It's not like it would be too hard to get the code, though. It is posted publicly on the Parallax Customer Application page. The text there is WAY different and is just a simplified paragraph telling what it does, not something NEAR the article. However, pictures are posted, so I am hoping (at this point) that this is not a concern?

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-03 01:38
    For many articles a lot of the bits and pieces are already scattered across the Internet. It's when someone brings it all together (and how they bring it together) that is starts to become unique. You're mixing in some of your own work as well. I wouldn't be too concerned since you've revised your postings. Just see if you can use e-mail to exchange revisions with those that have offered to review the content and provide feedback.

    Robert
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-03 02:14
    Thank goodness, it would be disappointing if I didn't get to submit the article.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-03 03:35
    You don't need to call out every picture in the article. Just some of the critical ones like specific figures, tables, etc. For the others just use a descriptive filename and you can describe the picture in the FILELIST.txt file which is a text file I include in extra ZIP file I send in so they know what each file is for. They've done a good job at organizing them and picking the best ones to use in the articles.
  • Timothy D. SwieterTimothy D. Swieter Posts: 1,613
    edited 2010-03-03 11:24
    Way to go Microcontrolled on jump starting with your first article!

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Timothy D. Swieter, E.I.
    www.brilldea.com - Prop Blade, LED Painter, RGB LEDs, 3.0" LCD Composite video display, eProto for SunSPOT
    www.tdswieter.com
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-03 19:33
    Thanks! I'll get the pictures organized into the file.
    I have all the pictures on an upload site I created because they do not upload fast on e-mails. Do they allow a web-based picture?

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-03 19:42
    Hello Micro,

    Here is an example if the FILELIST.txt file I sent for an article that was published on BOB. I included this file in each of the ZIP files I sent in. Once they unzip all of them they should have everything listed in that file.

    File list:

    Article:
    BOBpart2.doc - Article
    Contact.txt - Author Contact info
    Bio.txt - Author BIO

    Images:
    bobbase.JPG - Picture of how everything mounts to base
    topobatterymonitor.JPG - Picture of original TOPO Battery Monitor board
    powertop.JPG - Picture of the custom power board
    powerbottom.JPG - Picture of custom power board (bottom)
    powerlabel.JPG - Picture of labels for power board
    powerwiring.JPG - Picture showing power wiring
    sonarmuxtop.JPG - Picture showing Sonar MUX board
    sonarmuxbottom.JPG - Picture showing Sonar MUX board (bottom)
    sonarmux.JPG - Picture showing how boards look inside robot
    badwire.JPG - Picture showing poorly crimped connections
    encoder.JPG - Picture of original drive motor encoder

    Code Fragment for Article Text:
    Sonar_Select.txt - Subroutine to demonstrate sonar select MUX board.

    Schematic Drawings:
    BOB_Power.bmp - Schematic of custom power board
    BOB_SonarMUX.bmp - Schematic of custom Sonar MUX board


    This should give a pretty good idea of what you should have in that file. Depending on the article you may or may not need all the sections. Everyone does it a bit differently but this worked for me. It was in the March 2008 SERVO.

    Robert
  • MicrocontrolledMicrocontrolled Posts: 2,461
    edited 2010-03-05 02:00
    Almost have it ready. It *should* be sent off by Saturday. How long after you submit an article does it appear in the magazine?
    6 months? 12 months?

    Thanks,
    Micro

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Don't click on this.....
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-05 03:10
    Hello Micro,

    Sounds like you are well on your way. If you haven't contacted the magazine yet you probably should so they know to expect something. After you send it you can check in to make sure all the pieces made it there ok. Once they receive it they will let you know what they think. The timeframe for publication varies from magazine to magazine and depends on how many articles are ahead of yours and for some if it fits in with the theme of the issue. Also, if for some reason there is an opening it may get slipped in sooner. Usually figure at least 2-3 months but it could be more. If they like it and want to use the article then ask them approximately when it may come out.

    Also, if they need other pictures or clarification on any points that is something you can discuss with them after it is submitted.

    You've taken a big step forward and I hope it works out. Thing like this will look great on a resume for you and can lead into other things!

    Robert
  • LeonLeon Posts: 7,620
    edited 2010-03-05 07:05
    A long time ago I wrote a longish, rather humourous, letter to a computer magazine about the launch of the Sinclair QL. A publisher saw it, liked my writing style, and asked me to write a book. I used to write a regular column for a couple of magazines (one was under a pseudonym) and had a few articles on computing published on the technology page of a national newspaper. The magazines didn't pay all that much, but the articles didn't take long to write so I made quite a lot of money on an hourly basis. The newspaper paid very well; I got the usual union rate of a couple of hundred pounds for a 1000 words.

    Another contributor to one of the mags also wrote books on computing. He lived near me and a friend of mine visited him to ask him a question about something in one of his books; he was was a bit taken aback to find he was wearing a dress! I mentioned this to the editor and he told me that said contributor was writing the articles and books to finance a sex change operation.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Leon Heller
    Amateur radio callsign: G1HSM

    Post Edited (Leon) : 3/5/2010 7:34:05 AM GMT
  • PJAllenPJAllen Banned Posts: 5,065
    edited 2010-03-05 13:04
    So, Leon, what're you angling at?·

    [noparse][[/noparse]You have a bunch of guys about to turn blue here.]
  • LeonLeon Posts: 7,620
    edited 2010-03-05 13:52
    I was just pointing out that it's easy to get published. Or, were you wondering about how the sex change (I suppose I should call it gender reassignment) went?

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Leon Heller
    Amateur radio callsign: G1HSM
  • ElectricAyeElectricAye Posts: 4,561
    edited 2010-03-05 14:19
    Leon said...
    I was just pointing out that it's easy to get published....

    Well, I've never considered getting a sex change, but I have on occasion pondered a possible enhancement or two. Leon, are you telling me that perhaps there's still hope? Is writing for Nuts and Volts the way to fulfill my lifelong dream of standing out in a crowd?
  • LeonLeon Posts: 7,620
    edited 2010-03-05 14:27
    It's very gratifying to see oneself in print, and people might remember you for years to come. I wrote my book (on the 68000) about 25 years ago, and people occasionally contact me about it. There is a copy on Ebay if anyone wants to buy it:

    cgi.ebay.co.uk/Understanding-the-68000-By-Heller,-Leon_W0QQitemZ220539395158QQcmdZViewItemQQimsxq20100113?IMSfp=TL100113238002r28777

    I got £1,500 for it (outright sale, no royalties) which was a lot of money at the time. It only took me about three weeks to write it, which was a pretty good hourly rate.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Leon Heller
    Amateur radio callsign: G1HSM

    Post Edited (Leon) : 3/5/2010 2:37:38 PM GMT
  • RobotWorkshopRobotWorkshop Posts: 2,307
    edited 2010-03-05 16:01
    Hello Leon, I wanted to add a 68000 book to my library so I was the lucky person that snagged that copy from ebay. Not a bad price even with shipping. Amazon shows one copy available but they want about $40 plus shipping.

    It is nice to be in print and a few extra dollars can help with unexpected expenses. In my case the check arrived the same day my wife came back from the dentist and told me she had to get a crown. Even after insurance it adds up so.. poof! There went the money from the article. Sigh... I'm still glad that I did it and have some other articles in the works.

    Robert
Sign In or Register to comment.