Copyright (c) Hyperion Entertainment and contributors.

Difference between revisions of "EditorDoc:Main"

From AmigaOS Documentation Wiki
Jump to navigation Jump to search
Line 16: Line 16:
   
 
In the past, version 4.x of the Amiga operating system has been known by many names including OS4, AmigaOS4, etc. For consistency, editors should always label the OS as "AmigaOS" only. Everything on this wiki is assumed to apply to version 4.x of AmigaOS or higher. When it is important to distinguish between versions of the operating system, add an explicit version number or range like so: "AmigaOS 3.1" or "AmigaOS 4.x". Note there is a space after the "AmigaOS" label in all cases.
 
In the past, version 4.x of the Amiga operating system has been known by many names including OS4, AmigaOS4, etc. For consistency, editors should always label the OS as "AmigaOS" only. Everything on this wiki is assumed to apply to version 4.x of AmigaOS or higher. When it is important to distinguish between versions of the operating system, add an explicit version number or range like so: "AmigaOS 3.1" or "AmigaOS 4.x". Note there is a space after the "AmigaOS" label in all cases.
  +
  +
== AmigaOS Component Naming ==
  +
  +
There are a lot of AmigaOS components in the system. Some are resident in other components while others are contained in their own individual files. It is important to keep the name of the component separate from its logical manifestation. For example, "Intuition Library" is how we refer to the manifestation which is actually in the intuition.library.kmod file.
  +
  +
Depending on the context, you may need to refer to the actual file names. Which file contains the utility.library is very important when working on an installer for example. The utility.library is actually contained in the kernel.kmod file. However, when we are referring to the library in the general documentation it is referred to as the Utility Library.
  +
  +
Mixing of the component names and the component's logical manifestation should be generally avoided.
   
 
== Information Prior to AmigaOS 4.0 ==
 
== Information Prior to AmigaOS 4.0 ==

Revision as of 23:03, 25 April 2012

Documentation for Editors

This section contains information and guidance for wiki editors.

Help Wanted

This wiki is a semi-private wiki which only allows approved editors to make changes. If you would like to become a wiki editor, please contact us at the AmigaOS Web Site. Everyone has their own areas of expertise. Do not be shy about helping out even if you believe your contribution would be minor.

Written Permission

Material for this wiki may come from various sources such as the AmigaOS development team or third party sources. It is always important that written permission is obtained from the author(s) before material is used.

It is equally important that written permission be obtained to modify all submitted material on this wiki. AmigaOS will continue to evolve and thus so will any of the material on the wiki.

AmigaOS Naming

In the past, version 4.x of the Amiga operating system has been known by many names including OS4, AmigaOS4, etc. For consistency, editors should always label the OS as "AmigaOS" only. Everything on this wiki is assumed to apply to version 4.x of AmigaOS or higher. When it is important to distinguish between versions of the operating system, add an explicit version number or range like so: "AmigaOS 3.1" or "AmigaOS 4.x". Note there is a space after the "AmigaOS" label in all cases.

AmigaOS Component Naming

There are a lot of AmigaOS components in the system. Some are resident in other components while others are contained in their own individual files. It is important to keep the name of the component separate from its logical manifestation. For example, "Intuition Library" is how we refer to the manifestation which is actually in the intuition.library.kmod file.

Depending on the context, you may need to refer to the actual file names. Which file contains the utility.library is very important when working on an installer for example. The utility.library is actually contained in the kernel.kmod file. However, when we are referring to the library in the general documentation it is referred to as the Utility Library.

Mixing of the component names and the component's logical manifestation should be generally avoided.

Information Prior to AmigaOS 4.0

The focus of this wiki is AmigaOS 4.0 and higher. Material which exclusively pertains to prior versions of the AmigaOS should be removed. For example, there exists text which describe the 3D look of buttons, etc. as "new" which is clearly no longer the case. Such sections should be reworded or even removed entirely because in 4.0 the 3D look is assumed to be present.

References to AmigaOS Clones

This wiki is intended to cover the official AmigaOS only. Any references to clone systems should be removed. However, sometimes a clone system may have a well established defacto standard (e.g. TD64) which is also supported by AmigaOS. In those cases, it may make sense to describe the defacto standard in terms of a clone system.