Documentation Conventions

From Multiverse

Jump to: navigation, search

See Style Guide for questions of writing style and special wiki extensions and CSS styles you can use.

File path separators

The server runs on both Linux and Windows, but for convenience, the Multiverse documentaion will use Linux-style path separators (/). Since the client and tools run only on Windows, the documentation will use Windows-style separators (\).

Directory name conventions

For convenience, the Multiverse documenation uses the following symbolic directory names:

  • Client executable directory: client_home, by default C:\Program Files\Multiverse Client.
  • Client files directory (where the client saves local files): On XP: C:\Documents and Settings\username\My Documents\Multiverse World Browser; On Vista: C:\Users\username\Documents\Multiverse World Browser
  • Tools installation directory: tools_home, by default C:\Program Files\Multiverse Tools.
  • Server installation directory: mv_home. Since the zip or tgz archive has the path built-in, on Windows, we recommend C:\multiverse. On Linux, this might be something like /usr/local/multiverse or just /multiverse.
Personal tools