1. Introduction
  2. On textual conventions
  3. On the usage of links
  4. Specific layouts
  5. References

Introduction

The purpose of the following document is to propose a graphic chart regarding the NetBSD htdocs site, including this wiki, and give some examples so they can be reused quickly anywhere else.


On textual conventions

Remember that this is a wiki; its base syntax, Markdown, is more limited than the one you have when writing down man pages using packages like

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to [[!templatebody preprocessing loop detected on wiki/graphic_chart at depth 10]]

Description

Use this template to create a man page link. The template can use four parameters:

Examples

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 11]] man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 12]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 13]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 14]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 14]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 15]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 16]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 16]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 17]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 18]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 18]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 19]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 20]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 20]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 21]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 22]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 22]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 23]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 24]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 24]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 25]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 26]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 26]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 27]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 28]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

man page:

    [[!template  id=man name="ls"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 28]] man page, with section:

    [[!template  id=man name="ls" section="1"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 29]] man page, specifying section and architecture:

    [[!template  id=man name="ls" section="1" arch="i386"]]

Link to [[!template preprocessing loop detected on wiki/graphic_chart at depth 30]] man page, specifying section, architecture and collection:

    [[!template  id=man name="ls" section="1" arch="i386" collection="NetBSD-5.0"]]

, where data types (variables, pathnames, flags, functions, return values, ...) have each their associated types, or document markup language like [[!wikipedia preprocessing loop detected on wiki/graphic_chart at depth 30]].

This does not mean that we should not care about conventions, though. For convenience, prefer using the ones that are chosen by the HTML output of the .

Quoting

When quoting text from an outside source, use double quotes "...", and explicitly indicate its reference.

When you want to quote specific character(s), use single quotes. For example: all sentences end with a '.'.

Files and directories

Files and directories (and in a wider sense, paths) should be emphasized, e.g. fstab and rc.conf are found under /etc/.

Commands, options names and flags

When a command, or an executable, are referenced, they should be strongly emphasized; same goes for their optional flags and arguments, e.g. ls can be used to list the content of a directory, and, together with its -a flag, will output entries that start with a dot.

Functions, or specific part of code

Functions reference should be simply emphasized. It is preferable to give the associated file explicitly, to avoid confusions; in that case, use a colon `:' to separate file name from function name. Same goes when you want to pinpoint to specific zone in source files, like lines.

For example, the src/bin/print.c:printlong function is responsible for printing the long output from [[!template preprocessing loop detected on wiki/graphic_chart at depth 31]].

On the usage of links

You can find multiple types of links within the wiki:

  1. links to other pages of this wiki:
    1. index
    2. graphic chart (this page)
  2. explicit URLs:
    1. with a label:
    2. or without:
  3. last but not least, various services regarding NetBSD:
    1. problem reports: [[!template preprocessing loop detected on wiki/graphic_chart at depth 32]]
    2. : [[!template preprocessing loop detected on wiki/graphic_chart at depth 33]], [[!template preprocessing loop detected on wiki/graphic_chart at depth 34]]
    3. 's packages: [[!template preprocessing loop detected on wiki/graphic_chart at depth 35]], [[!template preprocessing loop detected on wiki/graphic_chart at depth 36]]

Always prefer using templates rather than hard-coding paths for external URLs. This helps both maintainability and readability.

Specific layouts

The wiki support different commands, shortcuts and templates that can help controlling the layout.

Code

TBC

Terminal/console-like output

If you want to write series of commands, eventually with their output, you can use the programlisting template.

[[!template preprocessing loop detected on wiki/graphic_chart at depth 37]]

File content

If you want to display the content of a file, and make a proper distinction with terminal output, use the filecontent template.

[[!template preprocessing loop detected on wiki/graphic_chart at depth 38]]

Warnings and notes

Warnings

TBC Provide a "warning" template, with a nice-looking icon and appropriate framing (light red fieldset, for example). Investigate Tango icons. Needs some CSS tweaking.

Notes

TBC Provide a "note" template, similar to the "warning" one (yellow-greyish maybe).


References

Last, some references:

Add a comment