FileSource

1 Usage[edit]

The FileSource template is used to indicate the source of any file used in this wiki. It should be added at the bottom of each page of the file namespace.

It puts a message box with a "light blue database" icon in the page, and adds this page to the File source category.

If the file source is located in STMicroelectronics intranet (restricted access), only signed-up users who have writing permissions, can see this location.

Usage:  {{FileSource | <source ID> | <file ID> | <comment>}}

Where:

  • <source ID> is the mandatory identifier of source of the file (see table below for the possible values)
  • <file ID> is the mandatory identifier of the file. Its values depend on the source identifier (see table below)
  • <comment> is an optional comment (see table below)
File source <source ID> <file ID> <comment>
STMicroelectronics Digital Assets Library (intranet - restricted access) Digital Assets Library Number of the document in this Library
Any space is replaced by a "%20" character
Not used
STMicroelectronics user guide files library (intranet - restricted access) User guide Relative path of the file source from the user guide files library root directory
Any space is replaced by a "%20" character
Not used
STMicroelectronics training files library (intranet - restricted access) Training Relative path of the file source from the training files library root directory
Any space is replaced by a "%20" character
Not used
STMicroelectronics UML diagrams' Git repository (intranet - restricted access) UML diagram Relative path of the UML diagram from the UML diagrams' Git repository root directory
Any space is replaced by a "%20" character
Not used
Internet Internet URL of the file source
Any space is removed
Optional link text
The file is "self-contained" (to modify the file, it is enough to download it) NA Optional comment Not used

2 Basic examples[edit]

You type You get
File source: document 7331 of the Digital Assets Library
{{FileSource | Digital Assets Library | 7331}}
Source.png

Source → STMicroelectronics

File source: document STM32MP157x-DKx.pptx of the user guide files library
{{FileSource | User guide | Boards/STM32MP157x-DKx.pptx}}
Source.png

Source → STMicroelectronics

File source: document STM32MP15-Software-Software architecture.pptx of the training files library
{{FileSource | Training | STM32MP15-Software-Software architecture.pptx}}
Source.png

Source → STMicroelectronics

File source: UML diagram quadrature_x4_encoding.txt of the UML diagrams' Git repository
{{FileSource | UML diagram | timers/quadrature_x4_encoding.txt}}
Source.png

Source → STMicroelectronics

File source: URL for OpenEmbedded
{{FileSource | Internet | http://www.openembedded.org/ | OpenEmbedded}}
Source.png

Source → OpenEmbedded

"Self-contained" file
{{FileSource | NA | (archive file)}}
Source.png

Source → not applicable (archive file)

3 More examples[edit]

You type You get
No <source ID>
{{FileSource}}
Source.png

Source → STMicroelectronics

Unsupported value for <source ID>
{{FileSource | Unsupported value}}
Source.png

Source → STMicroelectronics

No <file ID> for the Digital Assets Library
{{FileSource | Digital Assets Library}}
Source.png

Source → STMicroelectronics

No <file ID> for the user guide files library
{{FileSource | User guide}}
Source.png

Source → STMicroelectronics

No <file ID> for the training files library
{{FileSource | Training}}
Source.png

Source → STMicroelectronics

No <file ID> for the UML diagrams' Git repository
{{FileSource | UML diagram}}
Source.png

Source → STMicroelectronics

No <file ID> for the Internet
{{FileSource | Internet}}
Source.png

Source → No URL supplied!

No <comment> for the Internet
{{FileSource | Internet | http://www.openembedded.org/}}
Source.png

Source → http://www.openembedded.org/

No <file ID> for the NA
{{FileSource | NA}}
Source.png

Source → not applicable

4 Code[edit]

Source.png

Source → STMicroelectronics

Non Applicable

Attachments

Discussions