old-www/LDP/LG/faq/author.html

335 lines
15 KiB
HTML

<!-- startcut ======================================================= -->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html><head>
<TITLE>The Linux Gazette Author Information</TITLE></HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000"
LINK="#3366FF" VLINK="#A000A0">
<!-- ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
<!-- H4>"The Linux Gazette...<I>making Linux just a little more fun!</I>"</H4>
<P --> <hr> <P>
<!-- ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
<center>
<H1><A NAME="faq">
<img src="../gx/lg-penguin.gif" alt=" " ALIGN="left">
<font color="#B03060"><I>Linux Gazette</I> Author Information</font>
</A></H1>
Updated 27-Feb-2003
<P>
<EM>This page is for those who wish to write articles for Linux Gazette.<BR>
If you have any other questions,
see the <A HREF="index.html">Linux Gazette FAQ</A>.</EM>
</center>
<BR CLEAR="all">
<p><hr><p>
<!-- endcut ======================================================= -->
<OL>
<LI> <A HREF="#author">How can I become an author? How can I submit my article for publication?</A>
<LI> <A HREF="#deadline">Upcoming article deadlines</A>
<LI> <A HREF="#html_crash_course">The <I>LG</I> authors' crash course in HTML</A>
<LI> <A HREF="#html_style_guide">The <I>LG</I> authors' style guide</A>
</OL>
<P> <HR> <P>
<!-- =============================================================== -->
<A NAME="author"></A>
<H2>1. How can I become an author? How can I submit my article for publication?</H2>
<P> <I>Linux Gazette</I> is dependent on
<EM><STRONG>R</STRONG>eaders <STRONG>L</STRONG>ike <STRONG>Y</STRONG>ou</EM>
for its articles. Although we cannot offer financial compensation (this is a
volunteer effort, after all), you will earn the gratitude of Linuxers all over
the world, and possibly an enhanced reputation for yourself and your company as
well.
<p> New authors are always welcome. Read the rest of this FAQ for topic and format suggestions and submit your
<i>completed</I> work to <A href=mailto:articlesubmission@linuxgazette.com>articlesubmission@linuxgazette.com</A>.
If you're unsure whether the topic is appropriate, email a short description of your proposed
topic, an abstract, to the same address and you will be informed of its suitability. The goal
of <i>Linux Gazette</i> is to be an open community of contributors. There is no editor as such
and we're relying on authors to be self-editing. You know as well as anybody what topics are
interesting to the community. Additionaly, assume that your article is publishable, at most we'll
take a cursory glance at it, spell-checking and grammar are the author's responsibility.
<P> The following types of articles are always welcome:
<UL>
<LI> technical articles of a HOWTO nature. (How to set up a program,
how to maintain it, my experience running a program even if I'm not an expert,
etc.) <FONT SIZE=+1><STRONG>For ideas about possible articles,</STRONG></FONT>
look in the Mailbag for questions that keep recurring. Explicit requests for
articles appear at the top of the "Help Wanted -- Article Ideas" section.
<EM>Even if you're not an "expert", an article discussing how you arrived at a
solution by trial and error, and what problems you encountered along the way,
will be of interest to many readers. These real-life experiences are one of the
unique things </EM>LG<EM> can offer, because it's missing in most standard
documentation.</EM>
<LI> Articles demonstrating the use of Linux in an industry or
environment where it might not be commonly expected.
<LI> Software reviews, as long as it is a balanced review and
not simply an advertisement. Comparing the pros and cons of this program with
similar programs is a plus.
<LI> Reports from conferences, etc.
<LI> Anecdotes, lighthearted stuff, etc.
<LI> Other areas I haven't thought of.
</UL>
<P> We have all levels of readers, from newbies to gurus, so articles aiming at
any level are fine. If you see an article that is too technical or not
detailed enough for your taste, feel free to submit another article that fills
the gaps.
<P> Articles <STRONG><EM>not</EM></STRONG> acceptable include one-sided product
reviews that are basically advertisements. Mentioning your company is fine,
but please write your article from the viewpoint of a Linux user rather than as
a company spokesperson.
<BLOCKQUOTE><EM>
If your piece is essentially a press release or an announcement of a
new product or service, submit it as a News Bytes item rather than as
an article. Better yet, submit a URL and a 1-2 paragraph summary (free
of unnecessary marketoid verbiage, please) rather than a press release,
because you can write a better summary about your product than the
NewsBytes Editor can. The submission address for News Bytes is:
<A HREF="mailto:bytes@linuxgazette.com">bytes@linuxgazette.com</A>.
</EM></BLOCKQUOTE>
<P> Articles not specifically about Linux are generally not acceptable, although
an article about free/open-source software in general may occasionally be
published on a case-by-case basis.
<P> Authors retain the copyright to their articles, but readers are
free to copy and distribute the articles as much as they please. <I>LG's</I>
official copyright statement is at
<A HREF="../copying.html">http://www.linuxgazette.com/copying.html</A>.
<P> Articles should be written in simple HTML. Please read the
<A HREF="#html_crash_course"><I>LG</I> author's crash course in HTML</A> and
the <A HREF="#html_style_guide"><I>LG</I> author's style guide</A> below.
<P> The following was written in response to an author inquiry:
<BLOCKQUOTE>
The article must be about Linux, about programming normally done on a Linux
platform, etc. (Occasionally we may accept an article about a non-Linux
open-source topic.) LG has a wide variety of readers, so technical articles,
tutorial articles, human-interest stories and humor are all accepted. Rejected
are mindless Linux advocacy and Microsoft-bashing that you can find plentifully
in the advocacy newsgroups, and articles that appear to badmouth or slander a
company unfairly.
<P> The biggest criteria is, "Does the article provide new information, something
that hasn't been published in LG in the past year?" An article may overlap a
previous article in content, but is it a 100% overlap or is there any new
information or a different perspective? We do ask that authors use the LG
search engine and Index of All Issues to search for previous articles about the
same topic and link to them. This makes it easier for readers to find all the
useful information LG has on a certain topic.
<P> There is no word limit. Most articles are 2-12 screenfulls of text, but they
can be of whatever length necessary.
<P> For their first article or two, new authors are encouraged to send a short
summary or outline before writing it, to verify it will be accepted.
</BLOCKQUOTE>
<P> <HR> <P>
<!-- =============================================================== -->
<A NAME="deadline"></A>
<H2>2. Upcoming article deadlines</H2>
The deadline is "seven days before the end of the month" unless holidays or vacations
interfere.
<P>
<TABLE CELLPADDING="5" BORDER>
<TR><TH>Issue</TH><TH>Deadline for Articles</TH><TH>Comments</TH></TR>
<TR><TD>#89 April 2003</TD><TD>Monday, March 10, 2003</TD>
<TD>Early due to Editor's schedule</TD></TR>
<TR><TD>#90 May 2003</TD><TD>Wednesday, April 23, 2003</TD>
<TD>&nbsp;</TD></TR>
<TR><TD>#91 June 2003</TD><TD>Monday, May 19, 2003</TD>
<TD>Early due to Editor's schedule</TD></TR>
<TR><TD>#92 July 2003</TD><TD>Monday, June 23, 2003</TD>
<TD>&nbsp;</TD></TR>
<TR><TD>#93 August 2003</TD><TD>Monday, July 28, 2003</TD>
<TD>&nbsp;</TD></TR>
<TR><TD>#94 September 2003</TD><TD>Monday, August 25, 2003</TD>
<TD>&nbsp;</TD></TR>
<TR><TD>#95 October 2003</TD><TD>Monday, September 22, 2003</TD>
<TD>&nbsp;</TD></TR>
</TABLE>
<P>
Since we're not a paper magazine, we don't have a certain amount of space
to fill. So if you miss a deadline, don't fret; just send it in anyway and
it will go into the following issue.
<P> <HR> <P>
<!-- =============================================================== -->
<A NAME="html_crash_course"></A>
<H2>3. The <I>LG</I> Author's Crash Course in HTML</H2>
<P> Create the file using any text editor. Put a blank line between paragraphs
and begin each paragraph with <CODE>&lt;P&gt;</CODE>.
<P> Place <CODE>&lt;H2&gt;...&lt;/H2&gt;</CODE> around section titles, with a
blank line above and below. You may use H3 for subsections, H4 for
sub-subsections, etc, on up to H6. H1 is used by <I>LG</I> for the article
title.
<P> Place <CODE>&lt;PRE&gt;...&lt;/PRE&gt;</CODE> around program listings,
output, configuration file text, and anything else which must line up
vertically. <CODE>&lt;PRE&gt;</CODE> goes on its own line above the block, and
<CODE>&lt;/PRE&gt;</CODE> on its own line below. Everything inside this block
will appear in a monospaced font, and indentations and line breaks will be
displayed verbatim.
<P> To display a literal "&lt;" in your article, type <CODE>&amp;lt;</CODE>
instead. For "&gt;", type <CODE>&amp;gt;</CODE>. For "&amp;", type
<CODE>&amp;amp;</CODE>. Otherwise, the browser will try to interpret them as
parts of HTML tags rather than displaying them. <EM>Look especially in program
listings since these symbols are frequently used in shell commands or
mathematical expressions.</EM>
<P> There are other HTML tags (BR, EM, STRONG, UL, OL, DL, IMG) you may
optionally use to jazz up the document; see any HTML tutorial for their
syntax and meaning.
<P> A complete HTML document requires
<PRE>
&lt;HTML&gt;&lt;HEAD&gt;&lt;TITLE&gt;...&lt;/TITLE&gt;&lt;/HEAD&gt;&lt;BODY&gt;
</PRE>
at the top and
<PRE>
&lt;/BODY&gt;&lt;/HTML&gt;
</PRE>
at the bottom. You don't need to do this for a <I>Linux Gazette</I> article
because the Editor throws away your headers and footers and inserts the standard
<I>Gazette</I> header and footer (with navigation bars).
<P> <HR> <P>
<!-- =============================================================== -->
<A NAME="html_style_guide"></A>
<H2>4. The <I>LG</I> Author's Style Guide</H2>
<P> Keep the HTML as simple as possible. <I>Linux Gazette</I> is read on a
wide variety of graphical and text browsers, on new and old hardware.
<BLOCKQUOTE><EM>
Word processors (StarOffice, Microsoft Office) and HTML editors
are notorious for doing the "bad" things below, in an attempt to make the HTML
document look exactly like the word-processing document. Readers care about
your <STRONG>text</STRONG>, not about your fancy formatting. If your
word processor has an option to produce <CODE>simple</CODE> HTML without
styles, please use it. Or save the document as text and add the simple
HTML tags by hand. (The <CODE>&lt;P&gt;</CODE> before paragraphs and
<CODE>&lt;PRE&gt;...&lt;/PRE&gt;</CODE> around program listings are the
only tags that are vital.)
</EM></BLOCKQUOTE>
<DL>
<DT><STRONG>Good</STRONG>
<DD>
<UL>
<LI> <CODE>&lt;P&gt;</CODE> before paragraphs (<CODE>&lt;/P&gt;</CODE>
after paragraphs optional).
<LI> Standard markup tags (<CODE>&lt;A&gt;</CODE>, <CODE>&lt;EM&gt;</CODE>,
<CODE>&lt;STRONG&gt;</CODE>, <CODE>&lt;CODE&gt;</CODE>,
<CODE>&lt;BLOCKQUOTE&gt;</CODE>, <CODE>&lt;UL&gt;</CODE>,
<CODE>&lt;OL&gt;</CODE>, <CODE>&lt;DL&gt;</CODE>, etc).
<LI> <CODE>&lt;H1&gt;</CODE> around section headers. <EM>Use this instead
of a bold paragraph--that's what it's for!</EM>
<LI> <CODE>&lt;PRE&gt;</CODE> around program listings and output.
(Please also make a text file of the program listing; see
below.)
</UL>
<DT><STRONG>OK, but don't overuse</STRONG>
<DD>
<UL>
<LI> Images. Include the <CODE>ALT=</CODE>, <CODE>WIDTH=</CODE> and
<CODE>HEIGHT=</CODE> attributes in the <CODE>&lt;IMG&gt;</CODE>
tag.
If the image is &gt;&nbsp;600 pixels wide, link to it rather than
using an <CODE>&lt;IMG&gt;</CODE> tag. PNG or JPG only,
<A HREF="http://www.burnallgifs.org/">no GIFs</A>.
<LI> Tables. Use mainly for columns of data, not for layout.
<LI> Fonts &amp; colors.
</UL>
<DD>
<DT><STRONG>Bad</STRONG>
<DD>
<UL>
<LI> Styles.
<LI> Decorations and doodads on section headers. Sometimes these
are tolerated for variety; other times they are removed by the
Editor.
<LI> Extra <CODE>&lt;BR&gt;</CODE>'s and <CODE>&amp;nbsp;</CODE>'s
to achieve precise indentation or vertical space. The
reader cares about your text, not about your fancy formatting.
<LI> Platform-specific fonts. The only words you need are
<CODE>"helvetica"</CODE> (sans serif) and <CODE>"courier"</CODE>
(fixed-width). The default is roman (serif).
<LI> Javascript.
</UL>
</DL>
<P> Articles may be of whatever length necessary. 2-15 screenfuls is typical.
<P> At the top of the article or in the accompanying e-mail, clearly state:
title, author's name, author's email (as it should be published) and bio. The bio
is a few sentances about you for readers who are curious. It may be professional
or personal, funny or serious, whatever you wish. See the bios at the bottom
of most articles for examples.) The same bio will be reused for future articles
until you submit an updated one.
<P> Name the article <STRONG>author.html</STRONG> (where "author" is the
author's last name in lowercase ASCII letters). If you have images, program
listings or companion files, place them in a subdirectory
<STRONG>misc/author/</STRONG> and have your hyperlinks point there.
<P> If you have images, <EM>please</EM> include the ALT text, WIDTH and HEIGHT
in your IMG tags. Proper form is:
<PRE>
&lt;IMG ALT="Alterate text" SRC="misc/author/file1.jpg" WIDTH="140" HEIGHT="80"&gt;
</PRE>
The ALT text is for text browsers, blind users and those with images
turned off. WIDTH and HEIGHT allow the browser to display the article
around the image even before the image finishes downloading.
<P> If you have inline program listings a user might want to run without having
to type them all in by hand, <EM>please</EM> place a second copy of each
listing in a text file called called
<STRONG>misc/author/program.language.txt</STRONG> and put a hyperlink before
the PRE block, thus:
<PRE>
bla bla bla this listing: (&lt;A HREF="misc/author/trip.sh.txt"&gt;text version of this listing&gt;)
</PRE>
The ".txt" extension ensures the browser will not try to do something funny to
it. Since it's a text file rather than HTML, you should <EM>not</EM>
escape your "&lt;", "&gt;" and "&amp;" characters.
<!-- P> <HR NOSHADE SIZE=6> <P -->
<!-- =============================================================== -->
<P> <hr> <P>
<!-- BEGIN lgnav ::::::::::::::::::::::::::::::::::::::::::::::::::: -->
<A HREF="../index.html"
><IMG SRC="../gx/homenew.gif" ALT="[ Front Page ]" ALIGN=left></A>
<!-- END lgnav ::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
<!-- ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
</BODY></HTML>