Documenting standards for IPFire coding and displaying data rates, drive sizes, and dates.
This is just a beginning (outline) for future changes. Also known as the dreaded "work in progress".
Data rate
The amount of data sent over a network in a given amount of time. It is measured in bits per seconds (bps).
All data rates will be Megabit per second and displayed at Mbps (or maybe Mbit/s).
Keep in mind: bits is a small b. And bytes is a capital B.
Side thought: Mbps takes up a little less space - Mbps is 4 characters vs Mbit/s at 6 characters.
- maximum of two digits of precision (digits to right of decimal point). Example: 12.34 Mbps
- can be two, one or zero digits of precision. Example: 12.3 Mbps
- Q. should "significant digits" be set?
Example:
Traffic: In 255.70 kbit/s Out 5.49 Mbit/s)
become easier to read as:
Traffic: In 0.25 Mbps Out 5.49 Mbps
Gbps (or Gbit/s)
Gbps become 1200 Mbps (or 1200 Mbit/s or maybe 1,200 Mbit/s).
kbps (or kbit/s)
121 kbit/s become 0.12 Mbps (drop the 3rd decimal place)
File sizes
When it comes to file sizes, we have many of places where we show this in bytes or kilo bytes. We should do it as follows: 1 MiB, 17 GiB, etc.
All file sizes will be mebibyte or gibibyte.
| unit of measurement | display as | equivalent | comments |
|---|---|---|---|
| MebiByte | MiB | 1 MiB = 1,048,576 bytes | mega binary byte is a contraction |
| GibiByte | GiB | 1 GiB = 1,073,741,824 bytes | giga binary byte is a contraction |
- maximum of two digits of precision (digits to right of decimal point). Example: 12.34 MiB
- can be two, one or zero digits of precision. Example: 12.3 MiB
Date
All dates are displayed in the date format of yyyy-mm-dd as specified by international format defined by ISO (ISO 8601).
- YYYY is the year using all four digits (not two digits).
- MM is the month using two digits (and not just one digit). January = 01 to December = 12.
- DD is the day using two digits (and not just one digit).
- the date should displayed as local time.
Example: 2023-06-07
Time
Time is displayed in the date format of HH:MM (or maybe HH:MM:SS ?) as specified by international format defined by ISO (ISO 8601).
- HH is the hour using two digits and uses 24 hour format.
- MM is the minutes using two digits.
- SS is the seconds using two digits.
- the time should displayed as local time.
Example: 12:34 (or maybe 12:34:56)