Skip to content

Commit

Permalink
更新帮助规范
Browse files Browse the repository at this point in the history
  • Loading branch information
@LTCatt
LTCatt committed Aug 6, 2021
1 parent 701273d commit 1edd16f
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 17 deletions.
38 changes: 24 additions & 14 deletions 个性化/XAML 格式.xaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,16 @@
建议配合Ctrl + F 快速查找某项，例如：需要改变文本颜色，则搜索 “颜色” 准确定位查找。
Change by XiaoFans
-->

<local:MyCard Title="前言">
<StackPanel Margin="25,40,23,15">
<TextBlock Margin="0,0,0,4" FontSize="13" HorizontalAlignment="Center" Foreground="{DynamicResource ColorBrush1}"
Text="本篇简单介绍了在 PCL2 中使用 XAML 进行自定义页面的相关语法，由于内容繁多，建议下载本篇代码参考学习。" />
<local:MyButton Margin="0,8,0,8" Width="200" Height="35"
Text="下载本篇的代码" EventType="下载文件" EventData="https://gitee.com/sssysy/PCL2Help/raw/master/个性化/XAML 格式.xaml" ToolTip="下载本篇的代码" />
Text="下载本篇的代码" EventType="下载文件" EventData="https://github.com/LTCatt/PCL2Help/blob/master/个性化/XAML%20格式.xaml" ToolTip="下载本篇的代码" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="基础教学 1：纯文本">
<StackPanel Margin="25,40,23,15">
<TextBlock Margin="0,0,0,4"
Expand All @@ -25,6 +27,7 @@
Text="它还有许多可以调整的属性：Margin 调整边距，FontSize 调整字号，TextWrapping 则是启用自动换行。" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="基础教学 2：卡片属性、提示条" Margin="0,0,0,15" CanSwap="True" IsSwaped="True">
<StackPanel Margin="25,40,23,15">
<local:MyHint Text="local:MyHint 代表提示条，它默认是警告样式。" />
Expand All @@ -34,6 +37,7 @@
Text="卡片（local:MyCard）的 Title 属性决定了它的标题。&#xA;为卡片添加 CanSwap 属性让它可以被折叠，True 代表是，False 代表否。在此基础上，再使用 IsSwaped 属性调整它是否默认被折叠。" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="基础教学 3：长宽属性、图片">
<StackPanel Margin="25,40,23,15">
<TextBlock Margin="0,0,0,4" Width="320" HorizontalAlignment="Right"
Expand All @@ -43,6 +47,7 @@
<Image Height="50" HorizontalAlignment="Center" Source="https://www.mcbbs.net/template/mcbbs/image/logo_sc.png" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="按钮教学 1：基础">
<StackPanel Margin="25,40,23,15">
<TextBlock Margin="0,0,0,4"
Expand All @@ -51,8 +56,13 @@
Text="按钮可以做到很多事，例如将 EventType 属性改为 打开网页，然后在 EventData 属性中写入网址，即可通过点击按钮打开网页。" />
<local:MyButton Width="140" Height="35" HorizontalAlignment="Left" Padding="13,0,13,0"
Text="打开 MCBBS" EventType="打开网页" EventData="https://www.mcbbs.net/" />
<TextBlock Margin="0,10,0,10"
Text="或者将 EventType 属性改为 弹出窗口，然后在 EventData 属性中写入弹窗的标题与内容……" />
<local:MyButton Width="140" Height="35" HorizontalAlignment="Left" Padding="13,0,13,0"
Text="显示一个弹窗" EventType="弹出窗口" EventData="这是标题|标题与内容以竖线间隔。\n你也可以直接在其中换行。" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="按钮教学 2：属性">
<StackPanel Margin="25,40,23,15">
<TextBlock TextWrapping="Wrap"
Expand All @@ -65,6 +75,7 @@
Text="点击打开知乎" EventType="打开网页" EventData="https://www.zhihu.com/" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="按钮教学 3：启动游戏">
<StackPanel Margin="25,40,23,15">
<TextBlock TextWrapping="Wrap"
Expand All @@ -77,6 +88,7 @@
Text="使用 1.12.2 进入 Hypixel" EventType="启动游戏" EventData="1.12.2|mc.hypixel.net" ToolTip="服务器 IP：mc.hypixel.net" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="按钮教学 4：打开文件">
<StackPanel Margin="25,40,23,15">
<TextBlock TextWrapping="Wrap"
Expand All @@ -95,6 +107,7 @@
Text="定位游戏启动脚本" EventType="打开文件" EventData="explorer.exe|/select,LatestLaunch.bat" ToolTip="PCL2 会将上一次启动 MC 的脚本保存在 PCL 文件夹内，且名为 LatestLaunch.bat。&#xA;点击按钮会打开文件管理器，并且借助参数要求它选中这个文件。" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="按钮教学 5：其他命令">
<StackPanel Margin="25,40,23,15">
<TextBlock Margin="0,0,0,4"
Expand All @@ -107,15 +120,15 @@
Text="下载 MCBBS 的 Logo" EventType="下载文件" EventData="https://www.mcbbs.net/template/mcbbs/image/logo_sc.png" />
</StackPanel>
</local:MyCard>
<local:MyCard Title="复杂布局">

<local:MyCard Title="高级：复杂按钮布局" CanSwap="True" IsSwaped="True">
<StackPanel Margin="25,40,23,15">
<local:MyHint Margin="0,0,0,7" IsWarn="False"
Text="下面的按钮列举了全部 6 种 EventType 作为示例。" />
<TextBlock Margin="0,0,0,4"
Text="你需要用到 StackPanel 在一横行里塞下多个按钮，你可以仅在这个教学卡片的基础上稍作调整，来实现自己的按钮布局。" />
<TextBlock Margin="0,0,0,10"
Text="如果你要实现更复杂的布局，你必须使用 Grid 等控件。多百度吧……谷歌也行。" />

<!-- 这是第一行 -->
<StackPanel Orientation="Horizontal" HorizontalAlignment="Center">
<local:MyButton Margin="0,0,10,0" Width="140" Height="35" HorizontalAlignment="Left" Padding="13,0,13,0" ColorType="Highlight"
Expand All @@ -125,7 +138,6 @@
<local:MyButton Margin="0,0,10,0" Width="140" Height="35" HorizontalAlignment="Left" Padding="13,0,13,0"
Text="打开画图" EventType="打开文件" EventData="mspaint.exe" />
</StackPanel>

<!-- 这是第二行 -->
<StackPanel Orientation="Horizontal" HorizontalAlignment="Center" Margin="0,10,0,0">
<local:MyButton Margin="0,0,10,0" Width="140" Height="35" HorizontalAlignment="Left" Padding="13,0,13,0" ColorType="Red"
Expand All @@ -135,11 +147,10 @@
<local:MyButton Margin="0,0,10,0" Width="140" Height="35" HorizontalAlignment="Left" Padding="13,0,13,0"
Text="下载作者的头像" EventType="下载文件" EventData="https://www.mcbbs.net/uc_server/data/avatar/000/14/51/06_avatar_small.jpg?ts=1471402592" />
</StackPanel>

</StackPanel>
</local:MyCard>

<local:MyCard Title="全局动态资源绑定">
<local:MyCard Title="高级：全局动态资源绑定" CanSwap="True" IsSwaped="True">
<StackPanel Margin="25,40,23,15">
<TextBlock TextWrapping="Wrap" LineHeight="17" Margin="0,0,0,15"
Text="你可以使用全局动态资源绑定的方式来给你的控件赋予全局主题色。" />
Expand All @@ -162,10 +173,10 @@
</StackPanel>
</local:MyCard>

<local:MyCard Title="应用内嵌图片和列表项">
<local:MyCard Title="高级：预置图片和列表项" CanSwap="True" IsSwaped="True">
<StackPanel Margin="25,40,23,15">
<TextBlock TextWrapping="Wrap" LineHeight="17"
Text="你可以在进行引导时使用应用内嵌图片加强强调。"/>
Text="PCL2 中包含一些预置的方块与物品图片，可以直接使用。"/>
<StackPanel Orientation="Horizontal">
<Image Width="30" Height="30" Margin="15,15,0,15" Source="pack://application:,,,/images/Blocks/CommandBlock.png"/> <!-- 命令方块 -->
<Image Width="30" Height="30" Margin="5,15,0,15" Source="pack://application:,,,/images/Blocks/Cobblestone.png"/> <!-- 圆石 -->
Expand All @@ -179,14 +190,13 @@
<Image Width="30" Height="30" Margin="5,15,0,15" Source="pack://application:,,,/images/Blocks/Egg.png"/> <!-- 鸡蛋 -->
<Image Width="30" Height="30" Margin="5,15,0,15" Source="pack://application:,,,/images/Blocks/Fabric.png"/> <!-- 布料（Fabric 图标） -->
</StackPanel>

<TextBlock TextWrapping="Wrap" LineHeight="17"
Text="在需要更详细的列出内容时，你可以使用列表项来替代按钮。在列表项中，点击操作的使用方式同按钮的使用方式。"/>
<local:MyListItem Margin="-5,15,-5,8"
Logo="https://www.baidu.com/favicon.ico" SnapsToDevicePixels="True" Title="百度" Info="百度一下，你就知道！" Type="Clickable" PaddingRight="4"
EventType="打开网页" EventData="https://www.baidu.com/"/>
Text="在需要更详细的列出内容时，你可以使用列表项来替代按钮。在列表项中，点击操作的使用方式与按钮相同。"/>
<local:MyListItem Margin="-5,15,-5,0"
Logo="https://www.baidu.com/favicon.ico" Title="百度" Info="百度一下，你就知道！"
EventType="打开网页" EventData="https://www.baidu.com/" Type="Clickable" />
<local:MyListItem Margin="-5,0,-5,8"
EventType="打开帮助" EventData="帮助/自定义帮助.json" />
EventType="打开帮助" EventData="帮助/自定义帮助.json" Type="Clickable" />
</StackPanel>
</local:MyCard>

Expand Down
19 changes: 17 additions & 2 deletions 帮助/提交帮助 - 编写规范.xaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,23 @@
</StackPanel>
</local:MyCard>

<local:MyCard Title="选择帮助类别">
<StackPanel Margin="25,40,23,15">
<TextBlock Margin="0,0,0,12" LineHeight="17"
Text="在创建新的帮助条目时，请根据情况选择链接、弹窗或新帮助页面。" />
<TextBlock LineHeight="17"
Text="1、尽量使用网络中已有的教程帖，添加一个链接即可。若无必要，不必从头到尾重新写一遍。" />
<local:MyListItem Margin="0,0,0,12" SnapsToDevicePixels="True" Type="Clickable" PaddingRight="4"
EventType="打开帮助" EventData="Minecraft/新手教程.json" />
<TextBlock LineHeight="17"
Text="2、如果教程内容可以用几句话说清，则只需使用第二类帮助，弹出窗口说明即可，无需添加 XAML 页面。" />
<local:MyListItem Margin="0,0,0,12" SnapsToDevicePixels="True" Type="Clickable" PaddingRight="4"
EventType="打开帮助" EventData="启动器/手动选择Java路径.json" />
<TextBlock Margin="0,0,0,4" LineHeight="17"
Text="3、仅在你确认网络中没有类似教程，且一个弹出窗口无法完全说明内容时，才去添加 XAML 页面。" />
</StackPanel>
</local:MyCard>

<local:MyCard Title="帮助内容规范">
<StackPanel Margin="25,40,23,15">
<TextBlock Margin="0,0,0,2"
Expand Down Expand Up @@ -54,8 +71,6 @@
Text=" ✔ 在下载整合包后，还需要进行安装才能进行游戏，本教程介绍了整合包的安装方式" />
<TextBlock Margin="0,0,0,4"
Text="8、不要在 XAML 文件中使用嵌套的 MyCard。若有大量需要折叠的内容，请新建一个子帮助页面（例如本页）。" />
<TextBlock Margin="0,0,0,4"
Text="9、尽量使用网络中已有的教程，添加一个指向它的链接即可。若无必要，不必重新写一遍。" />
</StackPanel>
</local:MyCard>

Expand Down
2 changes: 1 addition & 1 deletion 帮助/自定义帮助 - JSON 格式.xaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<TextBlock Margin="0,0,0,6" LineHeight="17"
Grid.Row="2" Grid.Column="2" Text="String" />
<TextBlock Margin="0,0,0,6" LineHeight="17"
Grid.Row="2" Grid.Column="3" Text="帮助条目的图标，第一类默认为卷轴，第二类默认为命令方块。支持填写图片网址或本地文件地址。&#xa;对 PCL2 内置帮助库，应当不包含此项，全部使用默认图标。" />
Grid.Row="2" Grid.Column="3" Text="帮助条目的图标，第一类默认为草方块（弹出窗口为草径），第二类默认为命令方块。支持填写图片网址或本地文件地址。&#xa;对 PCL2 内置帮助库，应当不包含此项，全部使用默认图标。" />
<TextBlock Margin="0,0,0,6" LineHeight="17" FontWeight="Bold"
Grid.Row="3" Grid.Column="0" Text="ShowInSearch" />
<TextBlock Margin="0,0,0,6" LineHeight="17"
Expand Down

0 comments on commit 1edd16f

Please sign in to comment.