Publishing Guidelines

If you would like to publish to the ASP.NET Wiki, please adhere to the following Guidelines:

1. Clean HTML - Please do not copy-paste from Microsoft Word. See below for more specific instructions.
2. Image Dimensions - The max-width of an image is 600 pixels. Please re-size any images that you wish to share that are larger than 600 pixels

Urls  & Linking

Linking to New or Existing Pages

Entering [ [Publishing Guidelines] ] (without spaces between the brackets) in the wiki editor page will generate a link to this page.  If the named page does not exist it will be created. By default new links are created as sub-pages to the page where the link is created.  If the page exists elsewhere in the wiki then the link should point there unless the users specifies a subpage link. (See below)

1. Looks for sub-page first
2. Looks for sibling page
3. Looks for parent page
4. Looks for a primary page
5. Looks for any other page (first match)

There are some other options including:

• Basic Named Linking - Creating [ [Wiki Page|Hey Look at my Wiki Page] ] generates the link text “Hey look at my Wiki Page” that links to “Wiki Page” (or a new page creation link) 
• Creating a sibling page with the same parent - [ [../s] ] links to a sibling of the current subpage, e.g., on A/b, it links to A/s. This can be used in combination with the piped “|” named linking to create [ [../Sibling Page | Name for Page] ]
• Forcing a link to a sub-page/child page - [ [/s] ] links to a subpage, e.g. on A it is the same as [ [A/s] ]. If a user uses the “[ [/new page] ] notation it will create the link only to the page that is a child of the page you are on. So if there exists a “New Page” elsewhere in the hierarchy it will be different from this new page.

External Linking To and From the Wiki

The URLs for wiki articles can be referred to either by the full URL or as a partial URL: For example: http://wiki.asp.net/page.aspx/29/data-access/ is the same as http://wiki.asp.net/page.aspx/29/.  Linking from the wiki is as simple as using basic HTML linking or the editor's link button to generate a new link.

File Attachments 

File attachments work but are very basic (no editing, replacing, or deleting)

Images 

Whenever adding an images:

• If the image is larger than 600px it should be resized to 600px
• A drop shadow should be used (see above image)

Tags and Keywords

Keywords added to via the "Keywords" textbox in the editor are rendered as meta keywords in the HTML of Wiki articles. These keywords are also included in the search index, but are not displayed to the reader of the content. Please use tags for all new content created.

Formatting 

Use standard tags, such as <h1>, <h2>, etc.. All the formatting is done via style sheets (both for print and screen)

Article Titles 

The title of the document is stored separately and is used for the <title> tag, breadcrumbs, side-bar navigation, and most importantly the URL

In the above example the title of the article is "Data Access". The title is used in the browser's title bar, the Url, the breadcrumb and in the H1 tag of the page.

Table of Contents Pages 

There is an option in the editor for Wiki articles that can mark a page as a "Table of Contents" page, which basically adds links to all pages beneath it in the page hierarchy.  See the Data Access TOC page as an example: http://wiki.asp.net/page.aspx/29/data-access/

You must Login to comment.