New glossary

[jamesh]

The eagle-eyed may have spotted a new link at the bottom of the docs page, to a glossary.

https://www.raspberrypi.org/documentation/glossary/

This is designed to help out beginners who may be confused by some of the terms used in our documentation.

I'd be interested in any feedback on what is there, and also any thought on where it should be linked from. At the moment there is just the one link on the top docs page, and I think it's a bit too hidden.

https://www.raspberrypi.org/documentation/

[bensimmo]

I'll have a look through later
From the first few.
ARMv8
used on the Raspberry Pi 3 range; very similar to Armv7 in 32-bit mode

Perhaps say mention it's the 64bit mode.

Also for ARMv7 should it be mentioned that the Pi3 runs in that mode with Raspbian?
Is is that not quite true (32bit mode?)
I'm ignoring the V8 Pi2 as that just makes it confusing.


Should Arm be ARM ?

[tpyo kingg]

It might be useful to explain in a line or two what an API is because they are used heavily even in introductory scripting tutorials. Also, shebang might be mentioned as a means of steering people to or from ways of invoking said scripts. GNU could be mentioned, too, as it turns up in most manual pages.

Edit: and MQTT + TLS

[k-pi]

ARM - Archimedes Risc Machine - if I'm not mistaken.

VNC - Video Network Connection(?).

TP1/TP2 a little more explaination of what they are for, perhaps.

[davidcoton]

ARM - Archimedes Risc Machine - if I'm not mistaken.

VNC - Video Network Connection(?).

ARM, previously Advanced RISC Machine, originally Acorn RISC Machine, is a family of reduced instruction set computing (RISC) architectures ...

Virtual Network Computing (VNC)

[Burngate]

... and also any thought on where it should be linked from. At the moment there is just the one link on the top docs page, and I think it's a bit too hidden.

I'd move it up a level to the "Help" tab, since it's more to do with generally Helping people than than just with the docs

(I'd also be wanting to make those tabs drop-down, rather than having to click on them)

[jamesh]

Should Arm be ARM ?

No, they use Arm (although i had always used ARM!).

[bensimmo]

Didn't know that, it must be a brand name now I guess and not mean the acronym anymore.
That or they got fed up with auto correct always making it Arm

I'll also get my son to have a look over and see what he thinks.

[jamesh]

Have added suggestions above that I think are relevent. Keep 'em coming!

Thanks all.

[bensimmo]

I2C could you add that to its counterpart, as it is actually more often used than I²C
I²C / I2C - .......


- I don't believe MQTT should be in the list yet. I cannot remember any document or lesson using MQTT.
Similar with GNU, its not particularly needed with respect to the Pi.


- With the TP's you need the PP's too.

[Heater]

"GNU" certainly deserves a place there.

It's the roots of all we hold dear. Arguably without the inspiration and software of the GNU project we would not be here with the Pi and discussing Raspbian.

[tpyo kingg]

- I don't believe MQTT should be in the list yet. I cannot remember any document or lesson using MQTT.

MQTT is mentioned there in The MagPi in several issues, if that counts:

• Issue 61; pp 50 - 53; "Live-Coding Online with Sonic Pi"
• Issue 64; pp 32 - 33; "Rapanui Clothing"
• Issue 69; pp 46 - 49; "Create a Touchscreen Control and Data System"

But aside from that it could be useful to know that it exists.

[bensimmo]

Just because GNU has a history to 'deserve it' it doesn't mean anyone needs to know or will use the term and want to look it up.
It's just adds clutter.

It would be more useful to have PinkPonies and what it means than GNU.

But it's up to James and so it's on.

[jamesh]

I2C could you add that to its counterpart, as it is actually more often used than I²C
I²C / I2C - .......

- I don't believe MQTT should be in the list yet. I cannot remember any document or lesson using MQTT.
Similar with GNU, its not particularly needed with respect to the Pi.

- With the TP's you need the PP's too.

MQTT comes up a fair bit on the forums, which is why I added it. GNU/Linux is the OS we use so I think that is relevent.

Not sure what you mean by I2C? That it's the same as I²C for those who don't know how to make their keyboard do ²?

[bensimmo]

I2C could you add that to its counterpart, as it is actually more often used than I²C
I²C / I2C - .......

- I don't believe MQTT should be in the list yet. I cannot remember any document or lesson using MQTT.
Similar with GNU, its not particularly needed with respect to the Pi.

- With the TP's you need the PP's too.

MQTT comes up a fair bit on the forums, which is why I added it. GNU/Linux is the OS we use so I think that is relevent.

Not sure what you mean by I2C? That it's the same as I²C for those who don't know how to make their keyboard do ²?

I2C is pretty much typed by everyone and used within Education probably for such reasons, also Wikipedia says it is an alternative spelling and pronunciation
(it also took me a few mins to find ² on my phone)
A good reference link though is https://www.i2c-bus.org

Just add it as the alternative search term with I²C like you have for A / mA

[DirkS]

Not sure what you mean by I2C? That it's the same as I²C for those who don't know how to make their keyboard do ²?

Wikipedia says

Alternatively I²C is spelled I2C (pronounced I-two-C) or IIC (pronounced I-I-C).

I see IIC quite a lot on the Chinese online shopping sites (aliexpress, banggood, etc)

[bensimmo]

A quick look at the Buy page
https://www.raspberrypi.org/products/
And we have
LAN, BLE, PoE, HAT (definitely HAT and a link to the spec?)
In the 3B+ buy box.

[Heater]

bensimmo,

Just because GNU has a history to 'deserve it' it doesn't mean anyone needs to know or will use the term and want to look it up.

That "history" is still going on and is still hugely significant.

I think all those millions of people using GCC on their Arduinos and Pis deserve to know where it came from.

Given the usage on this forum perhaps "Pink Ponies" should be in the glossary as well

[bensimmo]

It should be!
It's a glossary, a specific dictionary for the Raspberry Pi and related.

( pull-up being another I can think of )
There are many other technical terms but not sure if they need a quick explanation).

[hippy]

Alongside "GPIO" I'd add "GPIO header" or "GPIO connector", noting that it includes power connections as well as GPIO signals.

I would like a list of A-Z buttons at the top to allow quick jumping to the pertinent sections.

Given a glossary exists mostly for those who aren't familiar with the terms used, presumably includes "LED" for that reason; I would also include -

"Access Point" - A mode of operation which allows WiFi enabled devices to connect directly to the Pi just as one would connect to a broadband router.

"AIY " - Artificial Intelligence Yourself - A range of hardware and projects from Google which can be used with your Pi.

"apt / apt-get" - Advanced Packaging Tool - The software tools which allow you to keep your Pi software up to date.

"Back-Powering" - The means of powering a Pi other than by using a power supply connected to the micro-USB power connector.

"Bare Metal" - Programs which are developed for the PI which do not require any additional operating system to run them.

"Bluetooth" - Used to connect from your phone to the Pi or to connect the Pi to sensors.

"C, C++, Python, Java, Javascript, Assembler" - Programming Languages - The various languages which are used to write programs for your Pi.

"Compute Module" - A Pi variant which is intended for use by commercial customers.

"FFC" - Flexible flat cable - The very thin connecting cable which connects a camera or display to a Pi.

"Gadget Mode / Device Mode" - Using the Pi as a USB device plugged directly into the back of your PC rather than something which can have USB devices connected to it (Host Mode).

"HAT" - Hardware Attached on Top - Boards which plug into a Pi which conform to a specific specification except when they don't like the PoE HAT.

"IDE / IDLE" - Integrated Development Environment - The applications which allow users to create, edit, develop and debug their programming code.

"Open Source / Closed Source / Binary Blob" - <Your definition here>

"PCB" - Printed Circuit Board. The board to which the components which make up a Pi are attached.

"Pi" - 22 divided by 7 - ish. 3.1415926535897932384626433832795 ...

"Pink Ponies / Unicorns / Wheels / Sandwiches" - The usual means chosen to disrupt or derail a thread by those deliberately choosing to be disruptive or to create disharmony.

"PoE" - Power over Ethernet - A means of powering the Pi via an RJ45 network cable so no separate power supply or cable is needed.

"Polyfuse" - A self-resetting electronic fuse fitted to the Pi board which can help protect your Pi from electrical damage.

"root" - The user account on a Linux system which allows you to do pretty much anything.

"RPF" - Raspberry Pi Foundation - The very clever and smart people who created and brought you your Pi. The RPF is a UK registered charity; registration number 1129409.

"RPT" - Raspberry Pi (Trading) Ltd - The very clever and smart people who actually design and develop the Pi product range. RPT is the commercial arm and a fully-owned subsidiary of the RPF.

"rpiboot" - The software which allows Compute Module eMMC memory to be flashed and which allows a Pi in Gadget mode to have its software loaded from the PC or Pi it is plugged into.

"Schematics" - The electrical diagrams which show how components on a Pi board connect to each other.

"sudo" - The magic incantation to get god-like super-powers which allows you do things mere mortals cannot otherwise do. Please use with care.

"WiFi" - Used to connect your Pi to your broadband router or to allow your Pi to become an Access Point.

[tpyo kingg]

Some of the following might also be considered:

IP (Internet Protocol) IPv4 IPv6
AIY
RGB
MIDI
DIY
IDE
FAQ
CNC
CCTV
OLED
IC (Intergrated Circuit)
ASCII vs ISO-8859-x vs UTF-8
RF (Radio Frequency)
NAT
Embedded
Wizard
EEPROM
RTC
pHAT
SPI
6LoWPAN
ZigBee
M2M

By the way, Bluetooth Low Energy is also often abbreviated BTLE

[jamesh]

Ooooh, some good ones there. Thanks.

[epoch1970]

bcm 2708,09,10 in relation to bcm 2835,36,37?

[PhilBr]

Great idea. Add blue smoke? Ohm, Kilo ohm often written eg 3k3 for 3300 ohms or 3300 (ohms symbol).
Phil

[DougieLawson]

rpi-update (If you add rpi-update, add a note that it's NOT TO BE USED BY BEGINNERS)
rpi-source
etcher
NOOBS
PINN (explain why it may be a better option than NOOBS)