|
|
English | Português |
KeplerComponents
ToolsRelated SitesSponsorsBlue PiL |
|
||||||
Documentation FormatThe site documentation can use different formats depending on the type of object described (components, platform or the project itself).Documentation SyntaxThe documentation should be XHTML Strict compatible and use the Kepler CSS files. There is a default CSS file for general devices with a specific section for printing devices.Component DocumentationComponent documentation should be based on static files (HTML, images, CSS etc). API References, History logs and Examples should use the respective CSS classes. The file structure should follow the formatwww.keplerproject.org/projectname
General info (overview, news, history, credits, contact etc)
www.keplerproject.org/projectname/x.y
Version specific info (configuration, reference manual etc)
Platform DocumentationPlatform documentation should be based on static files. The file structure should follow the formatwww.keplerproject.org/platform
General info (overview, news, history, credits, contact etc)
www.keplerproject.org/platform/x.y
Version specific info (configuration, reference manual etc). Any references to components should point to the corresponding version of the component.
Project DocumentationProject documentation can use static files or wiki pages. The file structure should follow the formatwww.keplerproject.org/wiki/locale/pagename
locale can be US or BR and pagename should be an English name. Developer pages should be considered for internal use only and should not be linked to from the public pages. The page names should be preceeded by Dev and can use only the US locale.
|
|||||||
|
|||||||