3 Names of example items #
This section summarizes conventions for creating generic names for objects in documentation. Most of the following names are covered through entities. To check their spelling, refer to the Doc Kit repository at https://github.com/openSUSE/doc-kit/tree/main/entities. See also Section 9.3, “Entities”.
3.1 Domains #
Use http://www.example.com and http://www.example.org as example domains. Both domains were registered for use in documentation.
3.2 Host names #
Use objects of the solar system: For the most important system, use
sun. For other systems, use the names of planets
such as earth or mars.
3.3 IPv4 addresses #
Use addresses from the class C subnet 192.168.255.0
for examples. That is, replace the final 0 with any
integer between 0 and 255. To
create examples using a larger setup, use addresses from the private
network ranges. For more information, see
http://en.wikipedia.org/wiki/Private_network.
3.4 IPv6 addresses #
Use addresses from the subnet 2001:0db8::/32 for
examples. That is, after the 2001:0db8: prefix, add
six four-digit numbers, each separated by a colon on both sides. Each of
the hexadecimal digits may have a value between 0 and
f. A valid example URL is
2001:0db8:0123:4567:89ab:cdef:1234:5678. For more
information, see
http://en.wikipedia.org/wiki/IPv6_subnetting_reference.
3.5 Users #
For example users, use free-software mascots, such as Tux (Linux Kernel), Wilber (The GIMP), Geeko (SUSE), Foxkeh (Firefox), Konqi (KDE), or Duke (Java).