Difference between revisions of "Reading tips"

[quality revision] [quality revision]
m
m

This article provides a few tips for easy reading of this user guide.

1 Browsing[edit]

The user guide contains hundreds of articles (aka pages). As for any wiki website, an article might refer to tens of other articles, which might themselves refer to tens of other articles (and so on). It may be tempting to follow these links at the risk of moving away from the original article.

The articles are designed to be, as far as possible, self-sufficient.

With this in mind, it is good practice to keep the main article open in your browser, and to open any article linked by the main article in a new browser tab. Focus on the main article is hence maintained.


2 Links[edit]

Any link, either to an article of the user guide or to an internet website, appears in blue.

Example:

3 Image, clickable image and clickable image maps[edit]

An image might be:

  • a normal image - the image doesn't link to any destination
  • a clickable image - the entire area of the image links to a single destination
  • a clickable image map - some areas of the image link to multiple destinations

Move your mouse pointer over the images below to see what the mouse pointer and the display looks like for each image.

Image types available in the user guide
Normal image Clickable image Clickable image map
The image below simply shows the logo for the STM32 MP1 Series If you click on the image, you are redirected to the user guide main page If you click on the butterfly, you are redirected to the user guide main page.

If you click on "STM32 MP1", you are redirected to the STMicroelectronics website (st.com)

STM32MP1 logo.png
Link to the user guide Main Page
Link to the Main Page Link to the STMicroelectronics website
Example of clickable image map
Template:WarningImageMapOverlay

4 Commands[edit]

Any command that is executed on the board (through the remote Terminal or the Wayland Terminal) starts with Board $>, while any command executed on the host PC (through the local Terminal) starts with PC $>.

Example:

Board $> pwd

means that the "pwd" command shall be executed on the board: it will print the name of the current directory on the board.

PC $> pwd

means that the "pwd" command is executed on the host PC: it prints the name of the current directory on the host PC.


This article provides a few tips for easy reading of this user guide.

==Browsing==
The user guide contains hundreds of articles (aka pages). As for any wiki website, an article might refer to tens of other articles, which might themselves refer to tens of other articles (and so on). It may be tempting to follow these links at the risk of moving away from the original article.

The articles are designed to be, as far as possible, self-sufficient.

With this in mind, it is good practice to keep the main article open in your browser, and to open any article linked by the main article in a new browser tab. Focus on the main article is hence maintained.

{{InternalInfo|
'''Article restricted to STMicroelectronics employees'''
As STMicroelectronics employee, you access the user guide through an intranet URL (internal user guide). This user guide might contain information that is restricted to STMicroelectronics employees, and is therefore not included in the extraction of the user guide delivered to our customers (the delivered user guide).

Consequently, if you want to send customers any information extracted from the internal user guide, you must take care that '''it doesn't contain any restricted information'''.

There are 2 ways to identify restricted information:
* An article that belongs to the <nowiki>[[Category:ST internal]]</nowiki> category is fully restricted
* In an article, the information under the following banner is restricted
{{InternalInfo| Restricted information}}
}}

==Links==
Any link, either to an article of the user guide or to an internet website, appears in <span style="color: #39A9DC;">blue</span>.

Example:
* [[Main Page|Link to the user guide Main Page]].
* [https://www.st.com Link to the STMicroelectronics website]. Note the arrow icon that shows that the link leads to another site.

==Image, clickable image and clickable image maps==
An image might be:
* a normal image - the image doesn't link to any destination
* a clickable image - the entire area of the image links to a single destination
* a clickable image map - some areas of the image link to multiple destinations

Move your mouse pointer over the images below to see what the mouse pointer and the display looks like for each image.
{|
|+ Image types available in the user guide
! Normal image !! Clickable image !! Clickable image map
|-
| The image below simply shows the logo for the STM32 MP1 Series 
| If you click on the image, you are redirected to the user guide main page
| If you click on the butterfly, you are redirected to the user guide main page.
If you click on "STM32 MP1", you are redirected to the STMicroelectronics website ([https://www.st.com st.com])
|-
| [[File: STM32MP1 logo.png|center|link=]]
| [[File: STM32MP1 logo.png|center|link=Main Page|text|Link to the user guide Main Page]]
|
{{
ImageMap|Image:STM32MP1 logo.png {{!}} frame {{!}} center{{!}} Example of clickable image map <br/> {{WarningImageMapOverlay}}rect 55 17 172 118 [[Main Page|Link to the Main Page]]
rect 34 123 169 153 [https://www.st.com Link to the STMicroelectronics website]
}}
|}

==Commands==
Any command that is executed on the board (through the remote Terminal or the Wayland Terminal) starts with {{Board$}}, while any command executed on the host PC (through the local Terminal) starts with {{PC$}}.

Example:
 {{Board$}} pwd
means that the "pwd" command shall be executed on the board: it will print the name of the current directory on the board.

 {{PC$}} pwd
means that the "pwd" command is executed on the host PC: it prints the name of the current directory on the host PC.
<noinclude>

[[Category:MainMenuTab2]]
{{PublicationRequestId | 8430 | 2018-09-04 | PhilipS}}</noinclude>
Line 47: Line 47:
 
|
 
|
 
{{
 
{{
ImageMap|Image:STM32MP1 logo.png {{!}} frame {{!}} center{{!}} Example of clickable image map <br/> {{WarningImageMapOverlay}}
+
ImageMap|Image:STM32MP1 logo.png {{!}} frame {{!}} center{{!}} Example of clickable image map
 
rect 55 17 172 118 [[Main Page|Link to the Main Page]]
 
rect 55 17 172 118 [[Main Page|Link to the Main Page]]
 
rect 34 123 169 153 [https://www.st.com Link to the STMicroelectronics website]
 
rect 34 123 169 153 [https://www.st.com Link to the STMicroelectronics website]

Attachments

Discussions