Product Landing Pages

Product landing pages are designed to be the best place for users to quickly find technical information related to a Digilent product. Product landing pages use theDigilent Infobox Pluginto maintain a consistent look and feel and enable users to quickly locate the desired information and resources. All Product landing pages should followWiki最佳实践.

Example product landing pages:

Location

产品着陆页应位于/参考///开始

  • - 设备的产品家族。例如，PMOD，可编程逻辑，微处理器
  • - The product name. For example, pmodacl2, pmodad1, arty, basys-3

Sections

产品着陆页应按顺序包含以下各节：

Wiki配置参数

产品着陆页应禁用目录（TOC) using:

~~NOTOC~~

Title

The title should match the official product name with no additional descriptors.

例子：

  • 利用PMODACL2
  • NotPMODACL2Landing Page

Infobox

利用theDigilent Infobox Plugin创建特定产品的Infobox。至少每种产品应包括指向商店页面，参考手册和技术支持的链接。

Infobox Sections
  • Features
    • 从最终用户的角度描述产品。
  • Key Specifications
    • Specific technical description of the product features.
  • 电气
    • 相关的电气信息，例如供应电压，逻辑水平，总线等。
  • Physical
    • 宽度, length, weight, etc
  • 设计资源
    • Items the user will use when designing with the product.
      • Fritzing Part
      • Eagle file
      • Vivado板文件
      • Master XDG
  • Documentation
    • Documents related to the product. Things a user will consume (read) rather than use.
      • 主要IC-链接到设备上使用的主要IC的PDF数据表
      • 原理图- PDF schematic
  • 引脚
    • 每个连接器创建一个部分：
      • 截面标题应匹配连接器名称（例如J1，J2，J3）。
      • The first item in each section should be an image indicating pin numbers. These will generally be shared images that live in the product family namespace.
      • 将所有别针列为Pin X<主要功能>
        • 如果存在辅助函数，则在主函数之后将其添加到括号中。

示例Infobox：

Buy 参考Manual 技术支援
PMODACL2
3轴MEMS加速度计
Features
  • 利用r Selectable Resolution
  • Less than 2 uA consumption at 100Hz
  • Single or double tap detection
  • 活动和不活动监测
  • Free fall detection
Key Specifications
范围
±2/4/8G
解析度
12位
FIFO Depth
512个样品
电气
Bus
spi
Logic Level
3.3v
Physical
宽度
0.95英寸（2.41厘米）
Length
0.80 in (2.03cm)
设计资源
Fritzing Part
Documentation
Primary IC
ADXL362
原理图
Support
J1 PINOUT
Pin 1
〜cs
Pin 2
莫西
Pin 3
MISO
Pin 4
Sclk
Pin 5
GND
Pin 6
VCC
Pin 7
INT2
Pin 8
INT1
Pin 9
NC
Pin 10
NC
Pin 11
GND
Pin 12
VCC
J2 Pinout
Pin 1
INT1
Pin 2
GND
J3 Pinout
Pin 1
INT2
Pin 2
GND 

{{Digilent Infobox | Store Page = //m.knowreader.com/shop/pmod-acl2-3-axis-mems-accelerometer/ | Manual = [[reference-manual]] | Support = https://forum.digilentinc.com/forum/7-add-on-boards/ | Title = PmodACL2 | Subtitle = 3-Axis MEMS Accelerometer | Header = Features | Bullet = User Selectable Resolution | Bullet = Less than 2 uA consumption at 100 Hz | Bullet = Single or double tap detection | Bullet = Activity and inactivity monitoring | Bullet = Free fall detection | Header = Key Specifications | Range = ±2/4/8g | Resolution = 12-bits | FIFO Depth = 512 Samples | Header = Electrical | Bus = [[learn/fundamentals/communicaiton-protocols/spi/start | SPI]] | Logic Level = 3.3v | Header = Physical | Width = 0.95 in (2.41 cm) | Length = 0.80 in (2.03cm) | Header = Design Resources | Fritzing Part = {{pmodacl2.fzpz| }} | Header = Documentation | Primary IC = [[http://www.analog.com/media/en/technical-documentation/data-sheets/ADXL362.pdf | ADXL362]] | Schematic = {{pmodacl2_sch.pdf| }} | Header = Support | Header = J1 Pinout | Full Row = {{ :reference:pmod:pmod-pinout-2x6.png?direct |}} | Pin 1 = ~CS | Pin 2 = MOSI | Pin 3 = MISO | Pin 4 = SCLK | Pin 5 = GND | Pin 6 = VCC | Pin 7 = INT2 | Pin 8 = INT1 | Pin 9 = NC | Pin 10 = NC | Pin 11 = GND | Pin 12 = VCC | Header = J2 Pinout | Pin 1 = INT1 | Pin 2 = GND | Header = J3 Pinout | Pin 1 = INT2 | Pin 2 = GND }}

参考Manual First Section

使用包含插件嵌入产品参考手册中的产品概述和图像库：

{{page>reference-manual}}

维基Hosted Files

连接诸如原理图PDF之类的文件时，参考手册PDF，Fritzing零件等将文件上传到特定于文件的最高级别名称空间。例如PMODACL2files should be uploaded to the/reference/pmod/pmodacl2名称空间。这使得很容易找到并将这些文件包含在子页面中。

具有唯一扩展名（.fzpz，.brd等）的文件应命名较低的案例产品名称。例如，PMODACL2Fritzing零件应命名为“ PMODACL2.FZPZ”。

没有唯一扩展的文件（.pdf，.png，.vi）应命名如下：

  • -.extension
    • 是较低的案例产品名称。
    • is a lower case abbreviation of the content type.


例如the PDF version of thePMODACL2schematic should be named 'pmodacl2-sch.pdf'. The PDF version of thePMODACL2reference manual should be named 'pmodacl2-rm'.

Content types include:

  • 原理图- sch
  • 参考Manual - rm

代码库（可选）

在本节中包括指向代码库API的链接（不是示例项目）。如果不存在代码库，则省略此部分。首选指向GitHub存储库的链接，但不需要。

Split code libraries into the following sections:

  • 微处理器
  • Programmable Logic
  • LabVIEW

Call out non-Digilent libraries by adding the following after the library link:

  • by
    • When we know the name of the group / user that created the library.
  • - Community Library
    • When we do know know the name of the group / user that created the library.

Example Projects (Optional)

包括我inks to example projects in this section. Omit this section if no example projects exist.

Split code libraries into the following sections:

  • 微处理器
  • Programmable Logic
  • LabVIEW

Call out non-Digilent project by adding the following after the project link:

  • by
    • When we know the name of the group / user that created the library.
  • - Community Library
    • When we do know know the name of the group / user that created the library.

Tags

使用标签插件在产品页面底部添加标签。

始终包括：

  • Product family
  • 产品名称

Pmods:

  • pmod-start
    • 这表明这是一个PMOD着陆页
  • pmod-
    • Ex. pmod-spi pmod-i2c pmod-uart
  • 功能描述符
    • Ex. accelerometer, adc, temperature