Code Formatting Instructions for Developer Forums

Although this topic only applies to the two Developer forums, the need for some upfront code formatting instructions in those forums is desperate. There may be hundreds of threads which include one or more messages on this subject. In my case alone, I've posted at least a dozen messages each containing these three lines:
Paste your code here.
Of course a quick search of either Dev forum on the keys +code formatting+ will find the above right away, but those who need help the most don't know code requires special formatting so won't be making that search. For the same reason, neither the excellent instructions in the User Tips Library nor the pertinent threads in this forum are likely to be discovered before they're needed. The +Help & Terms of Use+ FAQ might seem to be a good place for the instructions, but this has been proposed so many times before I'm sure it will never happen. The need is confined to the Dev forums afterall.
I think the solution would be a permanent post (similar to +How to Post a new Topic+ in this forum) at the top of both Dev forums. I don't think most developers want to see instructions on any other topic at the top of the forums, but a brief note titled +How to Post Code+ might make everyone's life easier.
Assuming most of the other developers agree, how could we make this happen?

Thanks so much for helping with this, Nubz!
Joerg's instructions are excellent. I refer to them often and I've had them bookmarked since I found Apple Discussions last year. The new Code section is great!! Very clear!
Now we just need to find a way to get users to that page. Our problem has never been with users who are interested enough in Apple Discussions to visit the Tips Library. The unformatted code is coming from first-time users--not necessarily novice coders, but programmers of all skill levels who aren't coming here to learn about the forums or relate to the community. These folks are focused on their current project, may have found no answers anywhere else, and arrive here with tunnel vision. Often there's a language problem as well.
The newly arrived OP will often start the thread with a page of unformatted code. Those of us with eyes used to filling in the missing brackets, indentation etc. can sometimes decypher the mess, but usually we need to give formatting instructions and ask the OP to repost. The frequency of this scenario has been increasing. Lately I've been posting those instructions almost once every day.
Of course that's a good sign! We've been giving good service down there and the number of newcomers seems to be reflecting that. A big percentage have turned into regulars, so I think we have a very healthy forum. It's just the formatting cycle gets old, and the time and bytes add up too.
My suggestion is this:
One yellow moderator announcement that stays in the first position on the topic page for both dev forums. The subject line is:
To format code: Paste your code here
The user doesn't even need to open the message. Only developers will see this. No change to the page header is needed. If the user does open the message, a link will be provided to Joerg's tips.
- Ray

Similar Messages

  • Followed Format Instructions For Iomega Prestige 1 TB USB 2.0...

    Okay. I thought I was doing a good thing. I got a Iomega Prestige 1 TB USB 2.0. I followed the instructions for formatting it, which I think called for using Mac Extended version of some type...I put a bunch of stuff on it and shipped it off to my parents. They have an old Microsoft PC running Windows XP. They connected it up, but they are saying it doesn't show up as a drive on Windows...Is there something they can do on their side in order to be able to read it or must I start over? I would like for them to be able to read the drive and write to it as a small back up.
    Thanks for any feedback and insights.

    Ask them to install the MacDrive trial, copy off all the files, and reformat the drive. If that doesn't work, start over and either don't format the drive or choose MS-DOS as the format.
    (50387)

  • Can't 'create account' for developer forums. (iOS)

    I have an iOS dev membership, and everything else is working. But I can't access the developer forums.
    I get stuck at the Create Account screen where I have to "Specify a Screen Name". I choose a screen name, press the Create Account button, a wait spinner appears and then nothing happens. No error message, and no access.
    Anyone else having problems accessing the developer forums?

    I had the same issue as ron lauge
    Ron Lugge wrote :
    in my case, it turned out the issue was having two AppleId's both pointing to the same email (one of them was an old work based id, one was my 'real' apple ID)-- somehow that gunked up my primary account.
    And to solve it, I went into my old account and tried to access the developer forums from there, then I had to click renew (tho I didnt actually renew) and then went back to my current account and it worked fine.

  • Require activation code or instructions for CS2?

    Refer to your email 02-05-13 Case No. 0210696205

    Martin if you are looking for non-activating version of Creative Suite 2 please see http://forums.adobe.com/thread/1195856.

  • Need step by step instruction to develop first jsf application in eclipse

    Hello budy,
    I m really anxcious to learn the jsf technology, i can get the advance knoledge later as my own, just need instructions for developing first web application using jsf technology in the industy leader ide the eclipse ,. some questions produce in my mind while developing same application as:-
    1. what basic(common) jar files are needed to develop the application.
    2. how to configure all the necessary files, and what directory structure we need to follow.
    3. how to configure mysql database to use in the application using Hibernate persistence technology.
    Thanx

    See the tutorial, or buy a book. This is a ridiculous question to ask on a forum.

  • Jdeveloper: Tool Preferences Code Editor Save Actions. Why no code format?

    For me Format and Organize Imports are the 2 main save actions?
    Can I write a plugin or something to have the code format working for me?
    Best Regards,
    JP

    Which version of jdev you are talking about?
    In 11.1.1.2.0 I can select reformat as save action.
    Timo

  • Improvement request for the developer forums(s)

    Is there any way to tweak the developer forum a little so user's can see the proper way to format code when making a post? There is no mention in the help. The Compose tab only has bold, italic, underline, and spellcheck. Somewhere on the *Post Message: New Topic* screen there needs to be something telling the user to use {code} around their code to format it properly.
    I have been trying to inform newer users over there but it gets tiring after a while.
    Thanks.

    Even better - a button on the compose form that would insert the magic goo for us!
    Seriously this is a mess with all of the new iPhone developers coming onto the forms and putting code in their posts and then the responses from the usual suspects that they should use the tags, followed by questions of how do I use the tags,...

  • Request for iPhone developer forum

    There has been a recent influx of new iPhone developers in the developer forums. They often don't identify their problem as being specific to the iPhone. You have to look at what they are talking about and see that it is all iPhone stuff. Apparently the iPhone SDK is significantly different enough that answers to basic questions for MacOS X development are not correct for the iPhone SDK.
    If there were an iPhone SDK forum they might be more inclined to put iPhone-specific questions in there.

    I completely agree with the previous sentiments for an iPhone developer forum. Why?
    I am part of the problem. I have come into the Apple development process "solely" to work on the iPhone. I know nothing about Mac OS X. Because of that I was astounded that the iPhone documentation was not "iPhone" but rather Xcode documentation. Yes I understand that there is a great deal of overlap BUT from my point of view it looks as though Apple was extremely lazy in just dumping all of their code and documentation on the iPhone developer. They need about 5 editors to weed out what is and is not iPhone. Just my two cents.
    -Doug Danforth

  • Code Repository "In-Development" forum on LAVA

    The LAVA Forums has successfully run a LabVIEW Code Repository (CR) for over a year now with great success. Recently there was some interest for an area where members could have preliminary discussions on code that is in-development. An area where the code would be reviewed and discussed before the final Code Repository submission. We have now implemented this. We just added a new forum, see: Code Repository Code In-Development.
    This forum can be used by anyone who wants to present some code and
    evolve a discussion and review where the final product will be a
    submission to the LAVA Code Repository.
    There is currently no requirement to start a discussion in this forum in order to have code approved for the CR. Also, just because code is discussed in this forum does not necessarily mean that it will end up in the CR. The current CR requirements have not changed, See: Code repository support forum for submission guidelines.
    Some other use-cases:
    You
    can start discussions in this forum and present completed Code
    Repository code when you need to get feedback from the community (or
    the CR review committee) before you submit it to the Code Repository.
    You
    have some cool code but don't have time to evolve it into a proper
    submission. Others in the community can take it over (giving proper
    credit) and evolve it into a CR submission.
    You have an idea and really need some help from the community to get it implemented.
    You
    have finished code and need the community to do some Beta testing
    before an official CR release. This can also be for existing CR code
    that has a new upcoming version release.
    The list can go on...
    Michael Aivaliotis
    VI Shots LLC

    I'm glad things are working for you now.
    I wanted to add in something for anyone that may find this thread via Google at a later date.
    The orange STATUS LED blinks in specific patterns to provide information about your cRIO.  This is the LED you can go to your manual to read about the behavior.
    The USER FPGA 1 LED is something you can set in your FPGA code.  The behavior of this is not something that you can look in the manual to understand.  The behavior is determined by the programmer, not the hardware.  While it was a heartbeat in this case, it could be something as simple as turning the LED on when the program starts and turning it off when the program stops for another program.  The programmer could opt to leave it off entirely.  These are all appropriate uses of the FPGA 1 LED.  These could all also be programmed to represent an error.  That would also be an appropriate use.  Use this LED as you see fit to tell you what is taking place on your cRIO.  But, do not look into the manual for guidance as to what the LED is telling you.  For that information, you'll need to take a look at the code.
    Jeff B.
    Applications Engineer
    National Instruments

  • Instructions for compiling WRT350N code?

    I downloaded the WRT350N v1 1.03.2 source code from Linksys' site and I cannot for the life of me get it to make without errors. I'm using the latest Debian as my development system with all the latest patches. I followed the instructions in the README files and verified that the toolchain path is in my $PATH variable. Without changing anything with the firmware, I cannot get the router code to compile. I want to add in some other features, but if the firmware won't even compile with the defaults, then I don't want to go messing around with adding in other things just yet. Does anyone know where I can get some step-by-step instructions for getting this firmware to compile correctly?

    Ask at one of the 3rd party firmware projects like dd-wrt. They should know...

  • Code Formating after Forum Software Upgrade

    Hello SCN Forum Administrators,
    it seems that all code formating which was done with the
    [code]
    Tags was not automatically converted during the Forum Software Upgrade. What can I do to correct my code in the Forum Topic Re: Display ALV GRID with PHP? The message was posted by myself but I can't edit it.
    Best regards
    Gregor

    Hi all,
    the new forum version does contain a filter that can handle the old [code] tags. The problem was that we had to turn it off because it permanently ran into Stackoverflow errors and thus bringing the whole landscape into trouble.
    Now we have to convert all the old [code] markup in all messages with the new {code} markup. We are currently testing this.
    In other words: [code] is no longer supported, the usage of {code} is recommended.
    Regards,
    Michael

  • Need your suggestions for developing a Forum Site using Adobe Flex

    Hi ,
    I want to develop a small Forum Site where people can post questions and reply to questions .
    I want to develop the whole thing using Adobe Flex , Is there any plugin avialable for this .
    Means i mean to ask , if i go for normal J2EE there is a JForum avialable as far as i know .
    Please share your ideas .

    I meant "Don't use flex" unless you have some superb new design for a forum. I suspect that if you already had such a design, you wouldn't need to ask the question. Flex for Flex sake isn't good.
    There are already great html forum solutions out there.
    Basically, there's no point in duplicating in Flex what is already done in HTML, unless the Flex version offers a significant improvement to the user experience in some way.
    I am not aware of any Flex forum implementations and there is probably a good reason for that.
    Maybe someone else will know of one.

  • Is there any tool for developing Postscript code ?

    Hi Friends,
    Is there any tool for developing Postscript code ? (or)
    Is there any IDE for Postscript ? (or)
    Thanks & Regards,
    Navaneeth Sivappan

    Hi Navaneeth,
    > is there any tool for developing Postscript code ?
    An interpreter (GS or Dist), an ascii text editor and your PS skills ;-)
    > is there any IDE for Postscript ?
    Take a look in this Sourceforge project...
    http://sourceforge.net/projects/wxghostscript/
    ...is a Ghostscript debugger.
    MaRC anToni Malagarriga i Picas
    T·(34)938721642 | (34)667517069
    (][ www.femfum.com
    PostScript&PDF Tool Developers
    Desenvolupadors d'Eines PostScript i PDF

  • Tutorial & Code Sample for Developping Composites with CAF

    Do you have tutorials & Code samples for developping composites with CAF like Webdypro for Java as on this SDN site:
    https://www.sdn.sap.com/irj/sdn/developerareas/webdynpro?rid=/library/uuid/49f2ea90-0201-0010-ce8e-de18b94aee2d
    Thanls, regards, peter

    Take a look at https://www.sdn.sap.com/irj/sdn/developerareas/xapps?rid=/webcontent/uuid/7b9b3834-0801-0010-6a9a-dc53e0db37f2">the [original link is broken] [original link is broken].
    cheers,
    Marilyn

  • I have this formatted search for WharHouse Code in Document

    Hello Experts,
    I have this formatted search for WharHouse Code in Document
    declare @WhsCode char(8)
    if $[ODLN.Series] = '1077' set @WhsCode = '970'
    else set @WhsCode = '01'
    select @WhsCode
    and i would like to add to it:
    If an item has a default warehouse so it is to appear in a row (when not '1077' series) and if the item does not has a default warehouse then the  warehouse  eill be 01.
    Your Help Please!
    Thank You
    Meital

    Hi Meital,
    Try this:
    SELECT CASE WHEN $[ODLN.Series\] = '1077' THEN '970' ELSE ISNULL(T0.DfltWH,'01')
    FROM dbo.OITM T0 WHERE T0.ItemCode = $[$38.1.0\]
    Thanks,
    Gordon

Maybe you are looking for

  • Aperture 2.1.2 crashing constantly, will not allow me to move library/ create vaults

    Hi, I've searched for threads on this, but nothing came up with my particular situation. First, I'll state my specs iMac 24" (aluminum) 3.06GHz Core2 Duo 4GB RAM 500GB HDD So, after much procrastinating, I decided this weekend that I would organize m

  • Query related to replication method supported by ORACLE in 10g...

    Hi All, I have few question related to ORACLE replication methods. I have two database on different machine and I want to copy at schema level from source to target database. for this I have few queries related to Replication method as stated below:

  • How can I edit large amount of data using Acrobat X Pro

    Hello all, I need to edit a catalog that contains large amount of data - mainly the product price. Currently I can only export the document into excel file and then paste the new price onto the catalog using Acrobat X Pro one by one, which is extreme

  • Import not showing up in event where I try to upload it.

    I have a video that I have been trying to import to iMovie. The video is 3.14 GB, an MP4, and the dimensions are 1280 by 720. Whenever I import the video iMovie acts like it is importing the video, but when it is done the video is no where to be foun

  • Heat and sleep problem with my new Macbook Pro

    Basically I noticed with my new MBP the computer can become very hot and the fan gets very loud after about ~2 hours of working in Maya.. which I guess might be reasonable. However, my main concern is, even when I close the lid of the MBP, the heat s