Recent pages

Edit
page

New
page

Print
page
Page last modified 23:56, 11 Dec 2008 by Amy
0
Page Notifications Off
Documentation > Wiki Help : Wiki Naming Conventions

Wiki Help : Wiki Naming Conventions

From $1

Table of contents
  1. 1. Naming Conventions in the Wiki

Back to Wiki Help Topics

  1. 1. Naming Conventions in the Wiki

Naming Conventions in the Wiki

When creating a document in the wiki, you should be sure to create the new page in the proper documentation area. We have developed a set of naming conventions in the wiki that not only allow the context of a topic to be properly identified at a glance by a reader, the convention also optimizes searchability. This is why it is important to leave a space both before and after a colon. The table below shows not only the areas currently identified, but also the convention for that area. The proper way to create a link is also shown.

Note To view the way links are created in the Example links column, you need to enter edit mode.

 

Documentation Area Wiki Naming Convention Example Links 
Runtime Types Runtime Type : Types : Collection

<nowiki>Collection</nowiki>

renders as: Collection
Bungee Logic Schema Bungee Logic : Schema : Var

<nowiki>Var</nowiki>

renders as: Var
Bungee Logic Statements Bungee Logic : Statement : Call Function ()

<nowiki>Call Function ()</nowiki>

renders as: Call Function ()
Bungee Logic Sites Bungee Logic : Site : Path

<nowiki>Path</nowiki>

renders as: Path
Concepts Concept : Understanding Forms

<nowiki>Understanding Forms</nowiki>

renders as: Understanding Forms
Adapters Adapter :

 
Controls Control : Label <nowiki>Label</nowiki>

renders as: Label
HOW TOs How To : Adding a Class to a Project

<nowiki>Adding a Class to a Project</nowiki>

renders as: Adding a Class to a Project
Properties

Property : Image

<nowiki>Image</nowiki>

renders as: Image
Sites Site : Path

<nowiki>Path</nowiki>

renders as: Path
Wiki Help Wiki Help : How to Use this Wiki

<nowiki>How to Use this Wiki</nowiki>

renders as: How to Use this Wiki

 

Tags:
Naming_Conventions, Using_the_Wiki
Attach file or image
Files (0)
 
Images (0)
 
Comments (0)
You must login to post a comment.

 
Powered by MindTouch Core v.9.02.2