Java Tips Author Guidelines

Prepare your latest and greatest tips and tricks for submission to JavaWorld

First, it is important that you download the Java Tips template. Please use this template to submit your tip.

As shown by the Java Tips template, a well-organized Java Tip should contain these elements:

  • File format. Your Java Tip should be delivered in ASCII text either as an email attachment or included in the body of your email. If your article includes images and/or source code, all files should be emailed as a zip attachment. (The email address to which you should send your tip is provided at the end of the list of guidelines.)

  • Java Tip Title. This is the HEAD: tag in the template. It captures the primary focus of your tip, the solution you are presenting. (Example: "Explicit and recursive programming in Java")

  • Subtitle. This is the DECK: tag in your template. It builds on the title, providing more information on the content of the tip. (Example: "Use special Java style and idioms to ease maintenance without sacrificing performance")

  • Author name. Your name as you want it to appear on the article byline.

  • Summary. Describes what your Java Tip will cover and what readers can expect to gain from reading. The summary should tell readers at a glance why they should read the tip; convince them that they must read the tip -- without giving everything away!

  • Word count. Includes words only; do not include source code when counting the total words in the Java Tip. The target length of the tip article is 1,000-1,500 words, although articles out of that range can be accepted.

  • Introduction. Lends perspective, gives context, provides the big-picture view. The introduction sets the stage for the Java Tip, explains the learning opportunity/benefit the tip will offer, and who should care. After the introduction, which can be 1 to 2 paragraphs in length, you can focus on specifics.

  • Code listings. Code should be no wider than 80 characters per line.

  • Explanatory text for code listings. Identifies and explains the function of the code shown in the code listing.

  • Graphics. Screenshots, tables, and other images can be used as tools to explain concepts. Images should be saved in .gif or .jpg format and they should be no wider than 400 pixels.

  • Conclusion. Should wrap up the ideas presented in the Java Tip, reiterating main points made in article and reminding readers how this tip can be used to help them with their Java projects.

  • Resources. An annotated list of resources on the Web that relate to your Java Tip topic. (You can also list non-Web resources such as books where appropriate.) Each resource should consist of two elements: 1) a sentence or phrase that indicates what it offers and why readers should care about it; and 2) a complete URL.

  • Bio. Can include any or all of the following: job title, educational background, research interests relating to Java as well as other technical areas, publications, and hobbies. (Example: Java Tip 45.)

  • Contact information. You will be required to sign a JavaWorld Tips contract. Please include your email address to which all correspondence from the editors at JavaWorld should be addressed, as well as your regular ("snail mail") mailing address.

For a complete list of published Java Tips, go back to index of Java Tips.

Send it in! Now that you know the essential elements of a Java Tip, you can write it up and send it to: tips at javaworld.com. We strongly suggest that you package your tip article along with any screen shots and the source code files into a .zip archive.

This story, "Java Tips Author Guidelines" was originally published by JavaWorld.

Copyright © 2006 IDG Communications, Inc.