Help:Adding Article: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
(Created page with "<div class="rightmenu"> __TOC__ </div> == Naming == The actual type of the reference page (is it VectorScript or SDK or VCOM) is determined by the category in which the page ...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<div id="location-source">
.Help:Contents|Help
..Help:Contents|General Help
..Help:Adding Article|Adding Article
..Help:Adding Function Reference|Adding Function Reference
..Help:Adding General Function Reference|Adding General Function Reference
..Help:Adding VCOM Function Reference|Adding VCOM Function Reference
..Help:Adding VectorScript Function Reference|Adding VectorScript Function Reference
</div>
<div class="rightmenu">
<div class="rightmenu">
__TOC__
__TOC__
Line 4: Line 13:
== Naming ==
== Naming ==


The actual type of the reference page (is it VectorScript or SDK or VCOM) is determined by the category in which the page exist.
The actual type of the reference page (is it VectorScript or SDK or VCOM) is determined by the category in which the page exists.


The category is represented in the name before the semi-colon in the name.
The category is represented in the name before the semi-colon in the name.

Latest revision as of 14:34, 26 January 2023

.Help:Contents|Help ..Help:Contents|General Help ..Help:Adding Article|Adding Article ..Help:Adding Function Reference|Adding Function Reference ..Help:Adding General Function Reference|Adding General Function Reference ..Help:Adding VCOM Function Reference|Adding VCOM Function Reference ..Help:Adding VectorScript Function Reference|Adding VectorScript Function Reference

Naming

The actual type of the reference page (is it VectorScript or SDK or VCOM) is determined by the category in which the page exists.

The category is represented in the name before the semi-colon in the name.

For example "SDK:Something" is a page "Something" in category "SDK".

IMPORTANT Be careful when naming pages. The name is very important!

See Help:Contents#Page Name

Article Page

Article pages are pages focused to explain particular topic. They have general Wiki formatting (see Help:Contents).

Every article page have contents. To add it you have to add the following at the top of the page:

<div class="rightmenu">
__TOC__
</div>

Rules

General rules are:

  • Put the article in the appropriate category.
  • Put images to support the article.
  • Put sample code to support the article.

See Also