Jelajahi Sumber

Merge pull request #275 from youzi-2333/master

更新完善帮助库教程
龙腾猫跃 3 tahun lalu
induk
melakukan
35a71dd140

+ 12 - 11
帮助/提交帮助 - Git.xaml

@@ -18,26 +18,27 @@
                     Text="在开始之前请确保已经根据“参与完善 PCL2 帮助库”条目下的“获取帮助库”的指引,注册了 GitHub 并 Fork 了仓库。"/>
 		<TextBlock Margin="0,0,0,4" LineHeight="17"
                     Text="在开始获取 PCL2 帮助库之前不可缺少的是安装 Git 工具,你可以直接通过下面的按钮下载,或访问网页下载。"/>
-		<StackPanel Height="35" Margin="0,4,0,10" Orientation="Horizontal">
-			<local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left" ColorType="Highlight"
-                        Text="点击下载 Git(32位)" EventType="下载文件" EventData="https://registry.npmmirror.com/-/binary/git-for-windows/v2.39.2.windows.1/Git-2.39.2-32-bit.exe" />
-			<local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
-                        Text="点击下载 Git(64位)" EventType="下载文件" EventData="https://registry.npmmirror.com/-/binary/git-for-windows/v2.39.2.windows.1/Git-2.39.2-64-bit.exe" />
-			<local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
+
+        <StackPanel Height="35" Margin="0,4,0,10" Orientation="Horizontal">
+            <local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
+                        Text="下载 Git (32 位)" EventType="下载文件" EventData="https://registry.npmmirror.com/-/binary/git-for-windows/v2.37.0.windows.1/Git-2.37.0-32-bit.exe" />
+            <local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left" ColorType="Highlight"
+                        Text="下载 Git (64 位)" EventType="下载文件" EventData="https://registry.npmmirror.com/-/binary/git-for-windows/v2.37.0.windows.1/Git-2.37.0-64-bit.exe" />
+            <local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
                         Text="访问官网" EventType="打开网页" EventData="https://git-scm.com/" />
 			<local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
                         Text="访问镜像" EventType="打开网页" EventData="https://npm.taobao.org/mirrors/git-for-windows/" />
 		</StackPanel>
 		<TextBlock Margin="0,10,0,4" LineHeight="17"
-                    Text="1.点击下方按钮,进入 PCL 文件夹,创建名称为 Help 的文件夹。"/>
+                    Text="1. 点击下方按钮,进入 PCL 文件夹,创建名称为 Help 的文件夹。"/>
 		<StackPanel Height="35" Margin="0,4,0,10" Orientation="Horizontal">
 			<local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left" ColorType="Highlight"
-                        Text="打开文件夹" EventType="打开文件" EventData="explorer.exe|/select,Musics" />
+                        Text="打开文件夹" EventType="打开文件" EventData="explorer.exe|/select,Help" />
 		</StackPanel>
 		<TextBlock Margin="0,10,0,4" LineHeight="17"
-                    Text="2.进入 Help 文件夹,右键鼠标,单击&quot;Git Bash Here&quot;。你也可以使用其他命令行工具。"/>
+                    Text="2. 进入 Help 文件夹,右键鼠标,单击&quot;Git Bash Here&quot;。你也可以使用其他命令行工具。"/>
 		<TextBlock Margin="0,5,0,4" LineHeight="17"
-                    Text="3.在启动的命令行窗口中,逐行执行以下指令 (点击按钮即可复制文本)。"/>
+                    Text="3. 在启动的命令行窗口中,逐行执行以下指令 (点击按钮即可复制文本)。"/>
 		<StackPanel Margin="25,0,0,0">
 			<TextBlock Margin="0,5,0,4" LineHeight="17"
                         Text="① 生成公钥和私钥,与你的 GitHub 账号建立连接。"/>
@@ -52,7 +53,7 @@
 			<local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left" Height="35px"
                         Text="打开资源管理器" EventType="打开文件" EventData="explorer.exe|%homepath%\.ssh\id_rsa.pub" />
 			<TextBlock Margin="0,5,0,4" LineHeight="17"
-                        Text="③ 进入网页版 Github 的设置中,打开 SSH and GPG keys 项,点击 New SSH Key ,标题任意,内容粘贴打开文件的内容。"/>
+                        Text="③ 进入网页版 GitHub 的设置中,打开 SSH and GPG keys 项,点击 New SSH Key,标题任意,内容粘贴打开文件的内容。"/>
 			<StackPanel Height="35" Margin="0,4,0,10" Orientation="Horizontal">
 				<local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
                             Text="访问设置" EventType="打开网页" EventData="https://github.com/settings/keys" />

+ 2 - 2
帮助/提交帮助 - GitHub Desktop.xaml

@@ -10,7 +10,7 @@
                     Text="点击下方按钮,进入 PCL 文件夹,创建名称为 Help 的文件夹。"/>
         <StackPanel Height="35" Margin="0,4,0,10" Orientation="Horizontal">
         <local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left" ColorType="Highlight"
-                        Text="打开文件夹" EventType="打开文件" EventData="explorer.exe|/select,Musics" />
+                        Text="打开文件夹" EventType="打开文件" EventData="explorer.exe|/select,Help" />
         </StackPanel>        
         <TextBlock Margin="0,0,0,4" LineHeight="17"
                     Text="打开你 Clone 的仓库的本地文件夹,在文件浏览器中,开启“显示隐藏的项目”选项以选中 .git 文件夹。&#xa;此后,将整个 PCL2Help 内的内容剪切到 PCL/Help 文件夹下。"/>
@@ -20,7 +20,7 @@
         <TextBlock Margin="0,0,0,4" LineHeight="17"
                     Text="在 GitHub Desktop 仓库界面左侧栏,找到你修改的文件,并在文件左侧的方框中选中(仅选中一个文件,如要选中多个文件,请在 Commit to main 按钮上方的文本框输入消息)。&#xa;在右侧的文件预览中确认无误后,单击“Commit to main”(位于左侧栏的下方) "/>
         <TextBlock Margin="0,0,0,4" LineHeight="17"
-                    Text="在所有文件均提交完毕后,按下“Ctrl+P”以推送至 Github 。"/>
+                    Text="在所有文件均提交完毕后,按下“Ctrl+P”以推送至 GitHub。"/>
         <TextBlock Margin="0,0,0,4" LineHeight="17"
                     Text="在窗口标题栏下方,选中“Current branch”,再在子栏底部选择“Choose a branch to merge into master”以新建拉取请求。&#xa;选中 master 分支,并单击子窗口下方的蓝色按钮确认。"/>
     </StackPanel>

+ 2 - 2
帮助/提交帮助 - VSCode.xaml

@@ -32,9 +32,9 @@
         <Image Margin="0,0,0,8" HorizontalAlignment="Center" Source="https://cdn.newfei.top/image/2023/01/13/oE4T.jpg" />
         <Image Margin="0,0,0,4" HorizontalAlignment="Center" Source="https://cdn.newfei.top/image/2023/01/13/oPqS.png" />
         <TextBlock Margin="0,0,0,4" LineHeight="17"
-                    Text="3. 在主界面按下 “F1” 键打开指令输入框,输入 “Git Clone” 并回车。"/>
+                    Text="3. 在主界面按下 “F1” 键打开指令输入框,输入 “git clone” 并回车。"/>
         <TextBlock Margin="0,0,0,4" LineHeight="17"
-                    Text="4. 打开 Github Fork 仓库,点击右上角 Code 后复制仓库的 Git 链接,在 VSCode 主界面按下 F1(对于部分笔记本应按 Fn + F1)打开指令输入框,输入“Git Clone”并回车。"/>
+                    Text="4. 打开 GitHub Fork 仓库,点击右上角 Code 后复制仓库的 Git 链接,在 VSCode 主界面按下 F1(对于部分笔记本应按 Fn + F1)打开指令输入框,输入“Git Clone”并回车。"/>
         <TextBlock Margin="0,0,0,4" LineHeight="17"
                     Text="5. 点击下方按钮,进入 PCL 文件夹,创建名称为 Help 的文件夹。"/>
         <StackPanel Height="35" Margin="0,4,0,10" Orientation="Horizontal">

+ 27 - 27
帮助/提交帮助 - 编写规范.xaml

@@ -4,13 +4,13 @@
         <TextBlock Margin="0,0,0,4" LineHeight="17"
                     Text="在创建新的帮助条目之前,请先确认:" />
         <TextBlock Margin="0,5,0,2" LineHeight="17"
-                    Text="  1、在帮助库中搜索你想创建的帮助条目关键词,是否尚未收录此内容?" />
+                    Text="  1. 在帮助库中搜索你想创建的帮助条目关键词,是否尚未收录此内容?" />
         <TextBlock Margin="0,0,0,2" LineHeight="17"
-                    Text="  2、查看帮助库在 GitHub 上的 Pull Requests,是否没有其他人正在编辑此内容?" />
+                    Text="  2. 查看帮助库在 GitHub 上的 Pull Requests,是否没有其他人正在编辑此内容?" />
         <TextBlock Margin="0,0,0,2" LineHeight="17"
-                    Text="  3、你的条目需要适用于较多玩家,且有足够派上用场的可能。如果它面向的情景极少发生,那就不要添加它。" />
+                    Text="  3. 你的条目需要适用于较多玩家,且有足够派上用场的可能。如果它面向的情景极少发生,那就不要添加它。" />
         <TextBlock Margin="0,0,0,4" LineHeight="17"
-                    Text="  4、如果要添加网页条目,它需要有帮助性质,且必须是中文网站。比起添加整个站点,仅添加其中的特定帖子会有用得多。" />
+                    Text="  4. 如果要添加网页条目,它需要有帮助性质,且必须是中文网站。比起添加整个站点,仅添加其中的特定帖子会有用得多。" />
         <TextBlock Margin="0,5,0,4" LineHeight="17"
                     Text="此外,你可以多多参考已有的、顶部未标注 “需要重新整理格式” 或 “需要优化排版” 的 XAML 文件。&#xA;这些页面经过了审核,可以作为模板使用。你可以复制这样的文件,并在其基础上加以修改。" /> 
     </StackPanel>
@@ -21,56 +21,56 @@
         <TextBlock Margin="0,0,0,12" LineHeight="17"
                     Text="在创建新的帮助条目时,请根据情况选择链接、弹窗或新帮助页面。" />
         <TextBlock LineHeight="17"
-                   Text="1、尽量使用网络中已有的教程帖,添加一个链接即可。若无必要,不必从头到尾重新写一遍。" />
+                   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 页面。" />
+                    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 页面。" />
+                    Text="3. 仅在你确认网络中没有类似教程,且一个弹出窗口无法完全说明内容时,才去添加 XAML 页面。" />
     </StackPanel>
 </local:MyCard>
 
 <local:MyCard Title="帮助内容规范">
     <StackPanel Margin="25,40,23,15">
         <TextBlock Margin="0,0,0,2"
-                    Text="1、文档将被合并入 PCL2 官方,因此请使用官方视角编写文档,而不是个人视角。例如不要出现 “龙猫” 等措辞。" />
+                    Text="1. 文档将被合并入 PCL2 官方,因此请使用官方视角编写文档,而不是个人视角。例如不要出现 “龙猫” 等措辞。" />
         <TextBlock Margin="0,0,0,4"
-                    Text="2、使用书面化的正式语言,避免出现口语化的表达。" />
+                    Text="2. 使用书面化的正式语言,避免出现口语化的表达。" />
         <TextBlock Foreground="#DD4411" Margin="0,0,0,2"
-                    Text="    ❌  要修改这一堆帮助,你去提交 Pull Request 后还得等龙猫审核完才可以" />
+                    Text="    ❌  要修改这一堆帮助,你去提交 Pull Request 后还得等龙猫审核完才可以。" />
         <TextBlock Foreground="#229922" Margin="0,0,0,10"
-                    Text="    ✔  要修改 PCL2 的内置帮助库,在提交 Pull Request 后还需要等待审核" />
+                    Text="    ✔  要修改 PCL2 的内置帮助库,在提交 Pull Request 后还需要等待审核。" />
         <TextBlock Margin="0,0,0,2"
-                    Text="3、注意大小写。在中文与非中文的连接处添加一个空格(双引号除外)。使用中文标点符号(例如括号)。" />
+                    Text="3. 注意大小写。在中文与非中文的连接处添加一个空格(双引号除外)。使用中文标点符号(例如括号)。" />
         <TextBlock Margin="0,0,0,4"
-                    Text="4、使用 PCL2、Minecraft、Mojang 作为标准称谓。不要使用 我的世界、MC、mj 等非标准称谓或缩写。" />
+                    Text="4. 使用 PCL2、Minecraft、Mojang 作为标准称谓。不要使用 我的世界、MC、mj 等非标准称谓或缩写。" />
         <TextBlock Foreground="#DD4411" Margin="0,0,0,2"
-                    Text="    ❌  进入pcl的设置页,如果没有安装64位java,最多就只能分配1G内存" />
+                    Text="    ❌  进入pcl的设置页,如果没有安装64位java,最多就只能分配1G内存." />
         <TextBlock Foreground="#229922" Margin="0,0,0,10"
-                    Text="    ✔  进入 PCL2 的设置页,如果没有安装 64 位 Java,最多就只能分配 1G 内存" />
+                    Text="    ✔  进入 PCL2 的设置页,如果没有安装 64 位 Java,最多就只能分配 1G 内存。" />
         <TextBlock Margin="0,0,0,4"
-                    Text="5、使用客观详实的说明文文体,尽量避免时效性叙述与主观评价。" />
+                    Text="5. 使用客观详实的说明文文体,尽量避免时效性叙述与主观评价。" />
         <TextBlock Foreground="#DD4411" Margin="0,0,0,2"
-                    Text="    ❌  mj 在今年4月更新了 1.14,更新内容很多" />
+                    Text="    ❌  mj在今年4月更新了1.14,更新内容很多" />
         <TextBlock Foreground="#229922" Margin="0,0,0,10"
-                    Text="    ✔  Mojang 在 2019 年 4 月更新了 Java 版 1.14" />
+                    Text="    ✔  Mojang 在 2019 年 4 月更新了 Java 版 1.14。" />
         <TextBlock Margin="0,0,0,4"
-                    Text="6、考虑帮助的受众。如果面向新手,则应该写得尽量详细。如果面向高级用户,则应该省略部分基础内容。" />
+                    Text="6. 考虑帮助的受众。如果面向新手,则应该写得尽量详细。如果面向高级用户,则应该省略部分基础内容。" />
         <TextBlock Foreground="#DD4411" Margin="0,0,0,2"
                     Text="    ❌  在编辑帮助库的帮助中教学 “点击 Sign In 按钮登录”:能编辑帮助库的人应当可以自主完成这些操作" />
         <TextBlock Foreground="#229922" Margin="0,0,0,10"
                     Text="    ✔  在如何安装 Mod 的帮助中教学 “右键,点击剪切”:不会安装 Mod 的人确实需要极为详细的教学" />
         <TextBlock Margin="0,0,0,4"
-                    Text="7、避免使用评价性、剧情性的叙述,使用说明文文体。" />
+                    Text="7. 避免使用评价性、剧情性的叙述,使用说明文文体。" />
         <TextBlock Foreground="#DD4411" Margin="0,0,0,2"
-                    Text="    ❌  整合包里有许多好玩的 Mod,但下载之后如何安装却成了大家的一大疑惑,这篇教程会教会你如何安装" />
+                    Text="    ❌  整合包里有许多好玩的 Mod,但下载之后如何安装却成了大家的一大疑惑,这篇教程会教会你如何安装。" />
         <TextBlock Foreground="#229922" Margin="0,0,0,10"
-                    Text="    ✔  在下载整合包后,还需要进行安装才能进行游戏,本教程介绍了整合包的安装方式" />
+                    Text="    ✔  在下载整合包后,还需要进行安装才能进行游戏,本教程介绍了整合包的安装方式。" />
         <TextBlock Margin="0,0,0,4"
-                    Text="8、不要在 XAML 文件中使用嵌套的 MyCard。若有大量需要折叠的内容,请新建一个子帮助页面(例如本页)。" />
+                    Text="8. 不要在 XAML 文件中使用嵌套的 MyCard。若有大量需要折叠的内容,请新建一个子帮助页面(例如本页)。" />
     </StackPanel>
 </local:MyCard>
 
@@ -115,14 +115,14 @@
 <local:MyCard Title="提交与审核">
     <StackPanel Margin="25,40,23,15">
         <TextBlock Margin="0,0,0,4"
-                    Text="1、打开 PCL2,刷新并检查文档是否可正常查看,排版是否美观,按钮是否正常工作,文中是否存在错别字。" />
+                    Text="1. 打开 PCL2,刷新并检查文档是否可正常查看,排版是否美观,按钮是否正常工作,文中是否存在错别字。" />
         <TextBlock Margin="0,0,0,4"
-                    Text="2、在 json 文件开头与 XAML 文件末尾留下作者信息。但如果你仅是修改已有文件中的个别措辞,没有大幅修改,则不建议将自己添加进作者名单。" />
+                    Text="2. 在 Json 文件开头与 XAML 文件末尾留下作者信息。但如果你仅是修改已有文件中的个别措辞,没有大幅修改,则不建议将自己添加进作者名单。" />
         <TextBlock Margin="0,0,0,15"
-                    Text="3、如果没有完全完成某页,或你认为它还有优化空间,请在 XAML 的开头处添加类似于下方的提示条,以让他人可以继续修改。" />
+                    Text="3. 如果没有完全完成某页,或你认为它还有优化空间,请在 XAML 的开头处添加类似于下方的提示条,以让他人可以继续修改。" />
         <local:MyHint Margin="0,0,0,15" Text="该帮助页面还需要根据规范重新整理格式,优化排版与文案。如果你感兴趣也可以来帮帮忙!" IsWarn="False" />
         <TextBlock Margin="0,0,0,4" LineHeight="17"
-                    Text="在提交之后请耐心等待结果。如果没有通过,你可以继续进行修改,并在 Pull Request 页面重新要求 Code Review。&#xA;如果没有通过,且你 2 周没有任何新的操作,你的 Pull Request 会被删除。&#xA;如果已通过(Merged),你可以 QQ 私聊龙猫你的 PCL2 识别码,以换取活跃橙主题!" />
+                    Text="在提交之后请耐心等待结果。如果没有通过,你可以继续进行修改,并在 Pull Request 页面重新要求 Code Review。&#xA;如果没有通过,且你 2 周没有任何新的操作,你的 Pull Request 会被删除。&#xA;如果已通过(Merged),你可以 QQ 私聊龙腾猫跃,获取你的 PCL2 识别码,以换取活跃橙主题!" />
     </StackPanel>
 </local:MyCard>