产品着陆页

产品着陆页旨在成为用户快速查找与Digilent产品相关的技术信息的最佳位置。产品着陆页使用Digilent InfoBox插件保持一致的外观和感觉并使用户能够快速定位所需的信息和资源。所有产品着陆页应遵循Wiki的最佳实践。

示例产品着陆页：

地点

产品登陆页面应该位于/引用/ <产品族> / <产品名称> /开始

  • <产品族>-设备的产品系列。例如，pmod，可编程逻辑，微处理器
  • - 产品名称。例如，PMODACL2，PMODAD1，ARTY，BASYS-3

章节

产品登陆页面应按顺序包含以下部分:

Wiki配置参数

产品登录页面应禁用目录(TOC.） 使用：

~~ notoc ~~

标题

标题应与官方产品名称匹配，没有其他描述符。

例子:

  • 使用PmodACL2
  • 不是PmodACL2登陆页面

Infobox.

使用Digilent InfoBox插件创建特定于产品的信息框。每个产品至少应该包括一个链接到商店页面、参考手册和技术支持。

Infobox部分
  • 特征
    • 从最终用户的角度描述产品。
  • 主要规格
    • 具体技术描述产品特征。
  • 电
    • 相关电气信息，如电源电压、逻辑电平、母线等。
  • 身体的
    • 宽度，长度，重量等
  • 设计资源
    • 使用产品设计时用户将使用的项目。
      • 弗里丁的部分
      • 鹰文件
      • Vivado董事会文件
      • 主XDG
  • 文件
    • 与产品相关的文件。用户将消耗的东西（读取）而不是使用。
      • 主IC -链接到设备上使用的主IC的pdf数据表
      • 示意图 - PDF示意图
  • 引出线
    • 为每个连接器创建一个section:
      • section头应该匹配连接器名称(例如J1、J2、J3)。
      • 每个部分中的第一个项目应该是指示引脚数的图像。这些通常是生活在产品系列命名空间中的共享图像。
      • 列出所有引脚PIN X.<主要功能>
        • 如果存在辅助函数，将其添加到主函数后面的括号中。

例子细节:

买 参考手册 技术支持
PmodACL2
使用硬件MEMS加速度计
特征
  • 用户可选择的分辨率
  • 少于100岁的UA消费量赫兹
  • 单点或双击检测
  • 活动和不活动监控
  • 自由落体检测
主要规格
范围
±2/4/8g
决议
12位元
FIFO深度
512个样本
电
公共汽车
SPI
逻辑级别
3.3V.
身体的
宽度
0.95英寸(2.41厘米)
长度
0.80英寸（2.03cm）
设计资源
弗里丁的部分
文件
主要IC.
ADXL362
示意图
支持
j - 1引出线
销1
~ CS
销2
莫西人
PIN 3.
味噌
PIN 4.
SCLK
销5.
GND.
销6.
vcc.
PIN 7.
INT2.
销8.
INT1.
销9.
数控
销10.
数控
销11.
GND.
销12.
vcc.
J2引脚声音
销1
INT1.
销2
GND.
j3 incout.
销1
INT2.
销2
GND. 

{{Digilent InfoBox |存储页面= //www.knowreader.com/shop/pmod-acl2-3-axis-mems-accelerometer/ |手动= [[参考手册]] |支持= https://forum.digilentinc.com/forum/7-add-on-boards/标题= pmodacl2 |subtitle = 3轴MEMS加速度计|标题=特征|Bullet =用户可选择分辨率|Bullet = 100 Hz的少于2个UA消耗|子弹=单个或双击检测| 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 }}

参考手册第一部分

使用include插件嵌入产品参考手册中的产品概述和图片库:

{PAGE> REFENTIOM-MANUAL}}}}}}

Wiki托管文件

当附加诸如原理图PDF、参考手册PDF、压缩部分等文件时，将文件上传到特定于该文件的最高级别名称空间。例如PmodACL2文件应该上传到/参考/ pmod / pmodacl2名称空间。这使得在子页面中查找和包含这些文件变得很容易。

具有唯一扩展名的文件。Fzpz， .brd等)应该用小写的产品名称命名。例如,PmodACL2脆性部件应命名为“pmodacl2.fzpz”。

没有唯一扩展名的文件(.pdf， .png， .vi)应该如下命名:

  • - .extension
    • 是小写的产品名称。
    • <内容类型>是内容类型的小写缩写。


例如pdf版本的PmodACL2原理图应命名为“pmodacl2-sch.pdf”。PDF版本的PmodACL2参考手册应命名为“pmodacl2-rm”。

内容类型包括：

  • 示意图 - SCH.
  • 参考手册 - RM

代码库(可选)

在本节中包括到代码库api的链接(不是示例项目)。如果不存在代码库，则忽略此部分。首选链接到GitHub存储库，但不是必需的。

将代码库分成以下部分：

  • 微处理器
  • 可编程逻辑
  • LabVIEW.

在库链接后添加以下内容通过添加以下方式来调用非数字库：

  • 通过
    • 当我们知道创建库的组/用户的名称时。
  • - 社区图书馆
    • 当我们知道时知道创建库的组/用户的名称。

示例项目（可选）

在本节中包含符合示例项目的链接。如果不存在示例项目，请省略此部分。

将代码库分成以下部分：

  • 微处理器
  • 可编程逻辑
  • LabVIEW.

通过在项目链接后添加以下内容来调用非数字项目：

  • 通过
    • 当我们知道创建库的组/用户的名称时。
  • - 社区图书馆
    • 当我们知道时知道创建库的组/用户的名称。

标签

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

通常包括:

  • 产品系列
  • 产品名称

PMODS：

  • pmod-start.
    • 这表明它是一个pmod登录页面
  • PMOD- <总线>
    • 前任。PMOD-SPI PMOD-I2C PMOD-UART
  • 功能描述符
    • 前任。加速度计，ADC，温度