 | Уровень сложности: средний Doug Tidwell, IBM 工程师
17.09.2007 Your article abstract goes here. Put the main points and key
phrases at the beginning of the abstract, because it may be truncated in search
results. Include symbols for any trademarked terms, such as Java™ or
WebSphere®, as well as any HTML tagging needed for highlighting or
linking to
related developerWorks content. If
this article is part of a series, always point the reader to the
entire series.
Learn how to code the various content elements you can use in your article:
- Headings
- Major headings
- Minor headings
- Lists
- Ordered lists
- Unordered lists
- Code
- Code listing (several lines of code in a block)
- Inline code (code fragment in a sentence)
- Highlighting
- Sidebars
- Figures
- Tables (see the Tables section)
- Links (see the Links section)
Headings
Major headings appear in the content list in the left nav; this list is
automatically generated. Minor headings organize major sections into
smaller units and do not appear in the content list.
Lists
You can include ordered (<ol>) and unordered (<ul>)
lists anywhere in your article. Your lists can include code listings, tables, and
figures (such as a screenshot in a numbered procedure). In these cases, code the
listing, table, or figure inside the closing list item tag (</li>).
You can also include lists inside blockquotes (<blockquote>).
Code listings
Code listings are common in developerWorks content. Limit
code lines to no more than 90 characters. See the scale in
Listing 1 below; you should temporarily set your editor's
font to Courier or some other monospace font when checking line lengths. For
longer code lines, you must find suitable places to split the lines; long lines do
not autowrap. Code lines longer than 90 characters will truncate printed-copy text
(in typical portrait layout).
Listing 1. Sample code listing at maximum width
<!-- Please limit code lines to 90 characters max. -->
<!-- The following line is the max length: -->
|-------10--------20--------30--------40--------50--------60--------70--------80--------90
000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
Line of code
Line of code
Line of code
Line of code
Line of indented code
Line of indented code
Line of code with <angle brackets>
Line of code with an ampersand (&)
Line of code with something in bold
|
Inline code and other highlighting
Use monospace code font (<code
type="inline">) for names of commands, such as the
make
install command, as well as for classes, objects,
methods, code snippets, and any text the user types in.
You can also use bold (<b>) for emphasis, and italics
(<i>) for clarity in text. For example, use bold for warnings or
cautions ("do not press Enter"), and use italics for terms defined in
content (Major headings appear...").
Sidebars, figures, and tables
You can include sidebars, figures, and tables in your article.
Sidebars
|
When to use a sidebar
Use a sidebar
for a content detour or reinforcement. For example, you might define terms or
provide a bit of historical background in a sidebar. Or you might summarize the
key points of a lengthy discussion. See a sidebar in action in
"Open
source development using C99". |
|
Technical graphics such as screen captures, diagrams, and photographs can enhance
and help explain your content. To learn how to create and deliver effective
graphics, read
"Illustrating
your article or tutorial for developerWorks".
Figure 1. Sample figure containing
an image
Tables
Use any of the following styles for tables in your article. Stick with the same
style throughout a single article. Table 1 uses a
traditional heading-style caption and left-aligned columns. Table 1 is the
recommended style, because its caption treatment matches that of figures and code
listings.
Tables 2 through 4 also show you other variations on column alignment,
subheadings, and row color. You can add these variations to any style of table.
Table 1. Table using a heading tag for the
caption, all columns left-aligned (recommended style)
| Header 1 | Header 2 | Header 3 |
|---|
| First cell in first row | Second cell in first row | Third cell in first row |
|---|
| First cell in second row | Second cell in second row | Third cell in second row |
|---|
| First cell in third row | Second cell in third row | Third cell in third row |
|---|
Table 2 has a right-aligned column and uses a caption tag
for the subheading. The caption tag is optional, and may be removed if a subheading is not required for the table.
Table 2. Table using a heading tag for the
caption, one column right-aligned, caption tag for subhead
Subheading for this table
| Header 1 | Header 2 | Header 3 |
|---|
| First cell in first row | Second cell in first row | $2,345.67 |
|---|
| First cell in second row | Second cell in second row | $765.43 |
|---|
| First cell in third row | Second cell in third row | $9876.54 |
|---|
Table 3 has a medium-blue table heading and no table border.
Table 3. Table using a heading tag for the
caption, medium-blue heading, and no table border
| Header 1 | Header 2 | Header 3 |
|---|
| First cell in first row | Second cell in first row | Third cell in first row |
|---|
| First cell in second row | Second cell in second row | Third cell in second row |
|---|
| First cell in third row | Second cell in third row | Third cell in third row |
|---|
Table 4 has alternating color rows.
Table 4. Table using a heading tag for the
caption, alternating color rows
| Header 1 | Header 2 | Header 3 |
|---|
| First cell in first row | Second cell in first row | Third cell in first row |
|---|
| First cell in second row | Second cell in second row | Third cell in second row |
|---|
| First cell in third row | Second cell in third row | Third cell in third row |
|---|
Links
To keep readers engaged with your content, and not wandering away mid-article to
pursue some other author's content, try to minimize off-site links in the
body of your article. Instead, in the body, link to the
Resources heading and include related content (articles,
tutorials, developerWorks downloads, views, technical briefings, Webcasts, demos,
books, Web sites, or offers) and urls there. Likewise, for code downloads and
demos, don't include the urls in the body; rather, link to the
Downloads section and include the urls there.
On the other hand, link freely to elements within the article, such as
headings, figures, code listings, and tables, and to other developerWorks
content, especially if the article is part of a series. For serial content,
include at least one link to the entire series in the body of the article. (In
addition, include a link to the entire series in the abstract and Resources
section.)
To sum up, you can include these types of links in the body of your article:
-
Link to "Resources": See the Resources section
for a link.
-
Link to "Downloads": See the Downloads section to
download the code.
-
Link to a heading: See how to add sidebars to your article in Sidebars.
-
Link to a code listing: See Listing 1 for a
sample code listing.
-
Link to a figure: See Figure 1 for a sample screenshot.
-
Link to a table: See Table 1 for a sample table.
-
Link to text: Find more detail about the
maximum width of code listings.
Загрузка | Описание | Имя | Размер | Метод загрузки |
|---|
| Sample Perl scripts for this article | sample.zip | 10KB | HTTP |
|---|
| A related PDF (not of the article)1 | sample2.pdf | 50KB | HTTP |
|---|
Другие файлы для загрузки Заметка - This is a sample note about the PDF.
- This is a sample note about the presentation.
Ресурсы Научиться
Получить продукты и технологии
- Download
IBM product evaluation versions
and get your hands on application development tools and middleware products from
DB2®, Lotus®, Rational®, Tivoli®, and
WebSphere®.
Обсудить
Об авторе | | |
在一个多中心的双盲临床测试中，Doug Tidwell 极大地缓解了由使用 XML 和 Java 技术进行编程而导致的季节性的过敏症状。
同时可以获得的还有药性温和（slow-acting）Doug Tidwell（Doug Tidwell SA），这是一种剂量相同但疗效达 24 个小时的治疗药。Doug Tidwell 的负作用通常比较轻，包括头晕、轻微至严重的恶心和四肢麻木，但很少出现瘫痪和死亡。
请询问您的医生，看 Doug Tidwell 是否适合于您。
关于更多细节，请咨询 Doug's blog。
|
Выскажите мнение об этой странице
| |
