Page History

Template Revision 2.3

TRM Name always "TE Series Name" +TRM, for example "TE0728 TRM"

<!-- tables have all same width (web max 1200px and PDF full page(640px), flexible width or fix width on menu for single column can be used as before) -->
<style>
.wrapped{
  width: 100% !important;
  max-width: 1200px !important;
 }
</style>

Important General Note:

• If some section is configurable and depends on Firmware, please refer to the addition page (for example CPLD). If not available, add note, that this part is configurable

• Designate all graphics and pictures with a number and a description, Use "Scroll Title" macro

  • Use "Scroll Title" macro for pictures and table labels. Figure number must be set manually at the moment (automatically enumeration is planned by scrollPDF)

    • Figure template:

      Scroll Title
      anchor Figure_anchorname title Text
      Scroll Ignore Create DrawIO object here: Attention if you copy from other page, objects are only linked. Scroll Only Image link to the generate DrawIO PNG file of this page. This is a workaround until scroll PDF export bug is fixed

      
      

    • Table template:

      • Layout macro can be use for landscape of large tables

    • 
      

      Scroll Title
      anchor Table_tablename title Text
      Scroll Table Layout orientation portrait sortDirection ASC repeatTableHeaders default style widths sortByColumn 1 sortEnabled false cellHighlighting true Example Comment 1 2

      
      

  • The anchors of the Scroll Title should be named consistant across TRMs. An incomplete list of examples is given below

    • <type>_<main section>_<name>

      • type: Figure, Table
      • main section:
        
        • "OV" for Overview
        • "SIP" for Signal Interfaces and Pins,
        • "OBP" for On board Peripherals,
        • "PWR" for Power and Power-On Sequence,
        • "B2B" for Board to Board Connector,
        • "TS" for Technical Specification
        • "VCP" for Variants Currently in Production
        •  "RH" for Revision History
      • name: custom, some fix names, see below
    • Fix names:
      

      • "Figure_OV_BD" for Block Diagram

      • "Figure_OV_MC" for Main Components

      • "Table_OV_IDS" for Initial Delivery State

      • "Table_PWR_PC" for Power Consumption

      • "Figure_PWR_PD" for Power Distribution
      • "Figure_PWR_PS" for Power Sequence
      • "Figure_PWR_PM" for Power Monitoring
      • "Table_PWR_PR" for Power Rails
      • "Table_PWR_BV" for Bank Voltages

      • "Table_TS_AMR" for Absolute_Maximum_Ratings

      • "Table_TS_ROC" for Recommended_Operating_Conditions

      • "Figure_TS_PD" for Physical_Dimensions
      • "Table_VCP_SO" for TE_Shop_Overview

      • "Table_RH_HRH" for Hardware_Revision_History

      • "Figure_RH_HRN" for Hardware_Revision_Number
      • "Table_RH_DCH" for Document_Change_History
  • Use Anchor in the document: add link macro and add "#<anchor name>
  • Refer to Anchor from external : <page URL>#<page name without space characters>-<anchor name>

-----------------------------------------------------------------------

Note for Download Link of the Scroll ignore macro:

• Link to the base folder of the module (remove de/ or en/ from the URL): for example:https://shop.trenz-electronic.de/Download/?path=Trenz_Electronic/Modules_and_Module_Carriers/4x5_Carriers/TE0728/

Download PDF version of this document.

Table of Contents

Notes :

• short description of the PCB

• Short Link of the wiki resources reference:

  • Use short link the Wiki Resource page, for example: http://trenz.org/te0728-info

  • List of available short links: https://wiki.trenz-electronic.de/display/CON/Redirects

• • Note:

Notes :

• Picture of the PCB (top and bottom side) with labels of important components
• Add List below

• Overview of Boot Mode, Reset, Enables,

Notes :

• For carrier or stand-alone boards use subsection for every connector type (add designator on description, not on the subsection title), for example:
  • SD
  • USB
  • ETH
  • FMC
  • ...
• For modules which needs carrier use only classes and refer to B2B connector if more than one is used, for example
  
  • JTAG
  • UART
  • I2C
  • MGT
  • ...

Notes :

• add subsection for every component which is important for design, for example:
  • Two 100 Mbit Ethernet Transciever PHY
  • USB PHY
  • Programmable Clock Generator
  • Oscillators
  • eMMCs
  • RTC
  • FTDI
  • ...
  • DIP-Switches
  • Buttons
  • LEDs

• This section is optional and only for modules.

• use "include page" macro and link to the general B2B connector page of the module series, for example: 6 x 6 SoM LSHM B2B Connectors
  

  Include Page
  6 x 6 SoM LSHM B2B Connectors 6 x 6 SoM LSHM B2B Connectors

• Set correct link to the shop page overview table of the product on English and German, if not available, set

  • https://shop.trenz-electronic.de/de/Produkte/Trenz-Electronic/

  • https://shop.trenz-electronic.de/en/Products/Trenz-Electronic/

• Note this list must be only updated, if the document is online on public doc!
• It's semi automatically, so do following
  

  • Add new row below first

  • Copy "Page Information Macro(date)" Macro-Preview, Metadata Version number, Author Name and description to the empty row. Important Revision number must be the same as the Wiki document revision number Update Metadata = "Page Information Macro (current-version)" Preview+1 and add Author and change description. --> this point is will be deleted on newer PDF export template

  • Metadata is only used of compatibility of older exports