FileSource

1. Usage

This template is used to indicate the source of any file used in this user guide.

It takes as first input parameter a string that identifies the source of the file. The possible values are:

• "Digital Assets Library": the file source is in STMicroelectronics Digital Assets Library (intranet - restricted access). Then, the second input parameter is the number of the document in this Library
  • {{FileSource | Digital Assets Library | 7331}}
• "User guide": the file source is in STMicroelectronics user guide files library (intranet - restricted access). Then, the second parameter is the relative path of the file source from the user guide files library root directory
  • {{FileSource | User guide | Boards/STM32MP157X-DKX.ppt}}
• "Training": the file source is in STMicroelectronics training files library (intranet - restricted access). Then, the second parameter is the relative path of the file source from the training files library root directory
  • {{FileSource | Training | STM32MP15-Software-%20Software%20architecture.pptx}}
• "UML diagram": the file source is in STMicroelectronics UML diagrams' Git repository (intranet - restricted access). Then, the second parameter is the relative path of the UML diagram from the UML diagrams' Git repository root directory
  • {{FileSource | UML diagram | timers/quadrature_x4_encoding.txt}}
• "Internet": the file source is Internet. Then, the second parameter is the URL of the file source. Optionally, a third parameter gives a link text.
  • {{FileSource | Internet | http://www.openembedded.org/}}
  • {{FileSource | Internet | http://www.openembedded.org/ | OpenEmbedded}}
• "NA": the file is self-contained (to modify the file, it is enough to download it). "NA" means "not applicable". Optionally, a second parameter gives a comment.
  • {{FileSource | NA}}
  • {{FileSource | NA | (archive file)}}

If the first input parameter contains any other string (or no string), then, the file source is considered as not yet filled:

• {{FileSource}}
• {{FileSource | Unknown value | Ignored field}}

2. Example

Source → exists

Source → STMicroelectronics intranet

Source → STMicroelectronics intranet

Source → STMicroelectronics intranet

Source → STMicroelectronics intranet

Source → OpenEmbedded

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

Source → not applicable

Source → not applicable (archive file)

Source → not yet filled

Source → not yet filled

3. Code

Source → not yet filled

Non applicable