User talk:SergeS

	Scope of the document

The goal of the proposed document is define and clarify used terms related to Kongsberg’s activities.
 * Generic Acronyms, Terminology and Definitions
 * Project File Names and Directories Structures Naming Conventions
 * Software Coding Styles:
 * Coding Styles: Style depends on used tool; C/C++/C# Naming Conventions
 * Accept styles which are depend on used tool
 * Kongsberg style, framework, APIs
 * Modularity, Layering, Drivers


 * FPGA Firmware Design Conventions
 * Modularity, Layering
 * Coding Styles

Naming Conventions and Syntax
To simplify references between documents proposed to use formal terms definition, including how it should be written.

   

::=...

Formal Types & Acronyms Definitions


 * Type		Short Definition or Comments


 * bool		0 = false, No; 1 = true, Yes


 * int		any value represented as an integer number


 * sint		signed integer


 * uint		unsigned integer


 * float		any value represented as a floating point number


 * u8		unsigned integer from 0 to 255 hold in one byte (8 bits)


 * s8		signed integer from -128 to 127 hold in one byte (8 bits)


 * u16		unsigned integer from 0 to 65535 hold in one two bytes (16 bits)


 * s16		signed integer from -32768 to 32767 hold in one two bytes (16 bits)


 * u32		unsigned integer 32 bits


 * s32		signed integer 32 bits


 * u64		unsigned integer 64 bits


 * s64		signed integer 64 bits


 * f32		floating point number 32 bits


 * f64		floating point number 64 bits


 * struct		particular set of parameters


 * NA		not applicable


 * //		Comments


 * ==		Equal


 * {m..n}		Range from m to n


 * {a,b,c}		Can accept values: a, b or c


 * Type[ ]		Array of type Type


 * enum		Enumerated values


 * TBD		To Be Defined


 * Host		Host related namespace


 * Head		Head related namespace


 * abs(V)		Operator: absolute value of V

Motor Acronyms and definitions
=Implementation – Wiki look and feel=

Selected Wiki type of implementation as a most suitable to meet our requirements.

Requirements
{| class="prettytable"  # 

Requirement

Short Description



Embedded Search Engine

Easy to find a term or definition



WYSIWYG

Very desirable,

Wiki-Engines Requirements
=Implementation – Wiki look and feel=

Selected Wiki type of implementation as a most suitable to meet our requirements.

Wiki Site Examples
Recommended

http://www.mediawiki.org/wiki/MediaWiki