Codex

Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Cn-cuckoo/撰写说明

This article is a ROUGH DRAFT. The author is still working on this document, so please do not edit this without the author's permission. The content within this article may not yet be verified or valid. This information is subject to change.
原文链接:Help:Editing

撰写说明

WordPress Codex中的样式约定与其他Wiki不同。要了解详细的样式规范,请参阅Codex:Styles。下列与撰写新文章有关的样式和标记涵盖了Codex中的具体样式,也包含来自MediaWiki's Guide: Editing Overview的建议和结构规范。要了解在页面中使用样式的更多信息,请参考:


In the chart below, in the left column of the table below, you can see what effects are possible. In the right column, you can see how those effects were achieved. In other words, to make text look like it looks in the left column, type it in the format you see in the right column.

You may want to keep this page open in a separate browser window for reference. If you want to try out things without danger of doing any harm, you can do so in the Sandbox.

小节、段落、列表和换行

要知道小节标题是什么样式,请参考本页中的小节。

要生成各级小节标题,需要输入:

== 新小节 ==

=== 新二级小节 ===

==== 新三级小节 ====

换行

要在文本中强制换行,可以使用XHTML标签<br/>。例如:

我打算在这里强制换行,<br />
看,这半句被换到了下一行。

得到的结果如下:

我打算在这里强制换行,
看,这半句被换到了下一行。

如果想生成一个新段落,则有两种方式:

  1. 在文本结尾回两次车,即让上一段最后一行与下一段第一行间产生一个空行
  2. 使用XHTML标签<p>和<p/>包装每个段落

例如,代码:

这是第一段。

这是第二段。

<p>这是第一段。<p/>
<p>这是第二段。<p/>

都会生成如下结果:

这是第一段。

这是第二段。

列表

  • Lists are easy to do:
    • start every line with a star
      • more stars means deeper levels
  • A newline
  • in a list

marks the end of the list.

  • Of course
  • you can
  • start again.
* Lists are easy to do:
** start every line with a star
*** more stars means deeper levels
*A newline
*in a list  
marks the end of the list.
*Of course
*you can
*start again.
  1. Numbered lists are also good
    1. very organized
    2. easy to follow
  2. A newline
  3. in a list

marks the end of the list.

  1. New numbering starts
  2. with 1.
# Numbered lists are also good
## very organized
## easy to follow
#A newline
#in a list  
marks the end of the list.
#New numbering starts
#with 1.
  • You can even do mixed lists
    1. and nest them
      • like this
        or have newlines
        inside lists
* You can even do mixed lists
*# and nest them
*#* like this<br />or have newlines<br />inside lists
  • You can also
    • break lines
      inside lists
      like this
* You can also
**break lines<br />inside lists<br />like this
Definition list 
list of definitions
item 
the item's definition
; Definition list : list of definitions
; item : the item's definition

Indents

NOTE: Indents are currently not working in the WordPress Codex styles. Indent when appropriate and this should be resolved soon.

A colon indents a line or paragraph.

A manual newline starts a new paragraph.

  • This is primarily for displayed material, but is also used for discussion on Talk pages.
: A colon indents a line or paragraph.
A manual newline starts a new paragraph.
IF a line of plain text starts with a space THEN
  it will be formatted exactly
    as typed;
  in a fixed-width font;
  lines won't wrap;
ENDIF
this is useful for:
  * pasting preformatted text;
  * algorithm descriptions;
  * program source code
  * ASCII art;
  * chemical structures;

Centered text

NOTE: Centered Texts are currently not working in the WordPress Codex styles. Center when appropriate and this should be resolved soon.

To center text, use the <center> HTML tag.
<center>Centered text.</center>

Horizontal Line

NOTE: Horizontal Lines are currently not working in the WordPress Codex styles. Add the lines when appropriate and this should be resolved soon.

A horizontal dividing line: above


and below.

In most cases a section header is more useful. The horizontal dividing line should only be used if what follows is logically part of the same section; otherwise that part would be hidden in the TOC.

A horizontal dividing line: above
----
and below. 

Links, URLs

Sue is reading about the WordPress_Features.

  • First letter of target is automatically capitalized.
  • Internally spaces are automatically represented as underscores (typing an underscore has the same effect as typing a space, but is not recommended).

Thus the link above is to http://codex.wordpress.org/WordPress_Features, which is the page with the name "WordPress Features".

Sue is reading about the [[WordPress_Features]].

When linking to another WordPress Codex page, the link does not need the underline in between the words:

[[WordPress Features]]

When linking to a WordPress Codex page from an external source, such as a blog, the underline is required.

To link to a section on a page, e.g. List_of_cities_by_country#Morocco; when section linking does not work the link is treated as link to the page, i.e. to the top; this applies for:

  • links to non-existent sections
  • links in redirects
  • interwiki links
[[List_of_cities_by_country#Morocco]].

It is recommended to reword the links when the link target and link label are different, such as linking to a seciton of linking from within the context of the article.

For example, you might want to link to a list of cities by country for Morocco.

...you might want to link to 
[[List_of_cities_by_country#Morocco|a list of cities by country for Morocco]].

A piped link is when you link to a target and the link label is different: For example, you want to link to the features of WordPress.

Same target, different name: [[WordPress Features|the features of WordPress]]

Endings are blended into the link: official positions, genes

Endings are blended
into the link: [[official position]]s, [[gene]]s

Automatically hide stuff in parentheses: kingdom.

Automatically hide namespace: Village pump.

The server fills in the part after the