Help:Style Manual

From NWN Lexicon
Jump to navigationJump to search

Some basics on how to format Lexicon pages.

New Function Page

This contains the layout of a typical function page. This uses level 4 headers, a better display title, and two new lines before the next header.

{{DISPLAYTITLE:FunctionName(object, int)}}__NOTOC__
One line description of the function.
<nwscript>
void FunctionNaame(
    object oObject,
    int bBoolean = FALSE
);
</nwscript>

====Parameters====

;oObject
:An object description
;bBoolean
:A boolean description


====Description====

Main description of function here.


====Remarks====

Remarks here.


====Version====

{{patchnwnee|patch=1.83.8193.21|link=https://steamcommunity.com/games/704450/announcements/detail/4622354803159314301}}


====Example====

<nwscript>
NWScript here
</nwscript>


====See Also====

{| class="seealso"
| width="1px" align="right" valign="top" | <font color="gray">functions: </font>
|
[[Function]]
|-
| width="1px" align="right" valign="top" | <font color="gray">constants: </font>
|
[[Constants]]
|-
| width="1px" align="right" valign="top" | <font color="gray">events: </font>
|
[[OnEventName]]
|}


[[Category:Functions]]

Templates

The NWNEE template is for marking NWNEE only pages. This may be depreciated at some point but for now use it liberally.

{{NWNEE}}

The Template:patchnwnee template is used for the Version section to automatically add categories for things added/changed in different patches, with a link to relevant patch notes.

{{patchnwnee|patch=1.80.8193.14|link=https://steamcommunity.com/games/704450/announcements/detail/2724067792533337541}}

The bug template is to mark known major bugs with a header.

{{bug}}

The GameInclude template is a header plus it adds the page to a category so people know what game includes contain what functions. EG: GetFleeToExit

{{GameInclude|include=x0_i0_position}}