AfterStep Proposed Topic Documentation Outline

From AfterWiki
Jump to: navigation, search

Introduction

The following is a proposed outline for the included AfterStep documentation. Most of this already exists; the goal is to maintain consistency from Topic page to Topic page within the documentation. All Topic pages will use this general format; if an item below isn't needed, then it will be skipped.


Outline

NAME / SUMARY (.c files) <-- fine as-is

SYNOPSIS <_synopsis> <-- fine as-is

DESCRIPTION <_overview> <-- a brief paragraph or two only.

CONFIGURATION FILES <_configuration_files> (was _base_configuration) <-- lists and summarizes configuration files used.

CONFIGURATION OPTIONS <GENERATED XML FILES> <-- AS magic :)

MYSTYLE CONFIGURATION <_mystyles>

DETAILS <_detail> (new) <-- more detail on usage and config that isn't included in overview

EXAMPLES <_examples>

SEE ALSO <_related>

FOOTNOTES <_footnotes>