Quellcode durchsuchen

尚未完成的 “提交帮助” 页面优化

LTCatt vor 5 Jahren
Ursprung
Commit
29b120ec84

+ 6 - 0
帮助/提交帮助 - GitHub Desktop.json

@@ -0,0 +1,6 @@
+{
+    "__Author__": "龙腾猫跃",
+	"Title": "参与完善 PCL2 帮助库 → GitHub Desktop",
+	"Description": "",
+    "ShowInSearch": false
+}

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


+ 1 - 1
帮助/提交帮助.json

@@ -1,5 +1,5 @@
 {
-    "__Author__": "龙腾猫跃",
+    "__Author__": "龙腾猫跃,Not_Killer_233",
 	"Title": "参与完善 PCL2 帮助库",
 	"Description": "从 GitHub 下载帮助库,帮助我们完善 PCL2 的帮助页面",
 	"Types": ["个性化"]

+ 42 - 47
帮助/提交帮助.xaml

@@ -1,7 +1,5 @@
 
-<!-- 作者:龙腾猫跃,Not_Killer_233-->
-
-<local:MyHint Margin="0,0,0,15" Text="该帮助页面尚未完成,其内容可能会在之后变更或进行补充。" />
+<!-- 作者:龙腾猫跃,Not_Killer_233 -->
 
 <local:MyCard Title="概述" Margin="0,0,0,15">
 <StackPanel Margin="25,40,23,15">
@@ -12,57 +10,54 @@
     </StackPanel>
 </local:MyCard>
 
-<local:MyCard Title="从 GitHub 获取帮助库" Margin="0,0,0,15">
+<local:MyCard Title="获取帮助库" Margin="0,0,0,15">
     <StackPanel Margin="25,40,23,15">
+        <local:MyHint Margin="0,2,0,10" Text="GitHub 目前在国内的访问不太通畅。如果遇到网络问题,请自行使用科学上网工具,然后为 Git 设置代理。" IsWarn="false" />
 	    <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                   Text="你需要将 GitHub 中的存储库克隆到 PCL\Help 文件夹。&#xa;本文内容将以安装了中文语言包的 Visual Studio Code与Github Desktop中的操作为例。当然,你也可以使用其他软件,只是操作可能略有不同。" />
+                   Text="在开始编辑前,你需要将 GitHub 中的存储库克隆到 PCL\Help 文件夹。" />
+        <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                   Text="你需要先注册并登录 GitHub 账号。此后,点击下方按钮打开 GitHub 存储库,然后点击页面右上角的 Fork 按钮创建一个分支。" />
         <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="GitHub 存储库" EventType="打开网页" EventData="https://github.com/LTCatt/PCL2Help" />
-            <local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
-                            Text="下载 VSCode" EventType="打开网页" EventData="https://code.visualstudio.com/Download" />
-            <local:MyButton MinWidth="210" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
-                            Text="如何将 VSCode 设置为中文" EventType="打开网页" EventData="https://code.visualstudio.com/docs/getstarted/locales#_changing-the-display-language" />
-            <local:MyButton MinWidth="140" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left" ColorType="Highlight"
-                            Text="下载Github Desktop" EventType="打开网页" EventData="https://desktop.github.com/" />
-        </StackPanel>
-        <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                   Text="在开始编译之前,你需要做一些准备工作。&#xa;首先,你需要拥有自己的Github账号。&#xa;Github在国内加载速度可能会很慢以至于加载不完全或者不能加载,这种情况请使用木棍" />
-        <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                   Text="注册完毕并登录后,打开PCL2帮助页面的仓库,并单击“Fork”(位于页面的右上角,你的头像下面)以创建一个分支。"/>
-        <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                   Text="如果你使用的是VSCode,则你还需要安装Git,VSCode将在右下方信息栏提示你安装,按照VSCode的引导安装即可。"/>
-        <local:MyCard Title="在Github Desktop中推送代码" Margin="0,0,0,15" CanSwap="True" IsSwaped="True">
-        <StackPanel Margin="25,40,23,15">
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="安装Github Desktop并打开设置。(按下“Ctrl+.”快捷键打开设置,注意使用英文符号)&#xa;在Accounts登录你的Github账号。"/>
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="按下“Ctrl+Shift+O”快捷键打开克隆仓库界面。&#xa;选中Github.com标签页,再选中Username/PCL2Help以克隆你Fork的仓库。" />
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="打开你Clone的仓库的本地文件夹,在文件浏览器中,开启“显示隐藏的项目选项以选中.git文件夹。&#xa;并将整个PCL2Help内的内容,复制到PCL/Help文件夹下”"/>
-            <local:MyHint Margin="0,0,0,15" Text="注意,在剪切后 .git 文件夹必须位于 PCL\Help,而不能在 PCL\Help\PCL2Help 子文件夹中。" />
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                    Text="使用你喜爱的编辑编辑译文件,并保存。"/>
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="在Github Desktop仓库界面左侧栏,找到你修改的文件,并在文件左侧的方框中选中(仅选中一个文件,如要选中多个文件,请在Commit to main按钮上方的文本框输入消息)。&#xa;在右侧的文件预览中确认无误后,单击“Commit to main”(位于左侧栏的下方) "/>
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="在所有文件均提交完毕后,按下“Ctrl+P”以推送至Github。"/>
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="在窗口标题栏下方,选中“Current branch”,再在子栏底部选择“Choose a branch to merge into master”以新建拉取请求。&#xa;选中master分支,并单击子窗口下方的蓝色按钮确认"/>
+            <local:MyButton MinWidth="150" Padding="13,0" Margin="0,0,20,0" HorizontalAlignment="Left"
+                            Text="为 Git 设置代理" EventType="打开网页" EventData="https://www.jianshu.com/p/290152303598" />
         </StackPanel>
+        <TextBlock TextWrapping="Wrap" Margin="0,0,0,14" LineHeight="17"
+                   Text="Fork 完成后,你需要使用软件获取你的分支内容。下文将以 GitHub Desktop 或安装了中文语言包的 VSCode 为例。" />
+        <local:MyCard Title="使用 GitHub Desktop 获取帮助库" Margin="0,0,0,15" CanSwap="True" IsSwaped="True">
+            <StackPanel Margin="25,40,23,15">
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="在开始前,请先根据下文中的 “第 1 部分:安装和身份验证” 完成对 GitHub Desktop 的安装与登录。"/>
+                <local:MyListItem Margin="0,2,0,10" Logo="pack://application:,,,/images/Blocks/CommandBlock.png" SnapsToDevicePixels="True" Type="Clickable" PaddingRight="4"
+		                          Title="GitHub Desktop 使用入门" Info="GitHub 的官方教程文档页,根据其中的内容完成安装与登录即可" EventType="打开网页" EventData="https://docs.github.com/cn/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop#part-1-installing-and-authenticating" />
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="打开你Clone的仓库的本地文件夹,在文件浏览器中,开启“显示隐藏的项目选项以选中.git文件夹。&#xa;并将整个PCL2Help内的内容,复制到PCL/Help文件夹下”"/>
+                <local:MyHint Margin="0,0,0,15" Text="注意,在剪切后 .git 文件夹必须位于 PCL\Help,而不能在 PCL\Help\PCL2Help 子文件夹中。" />
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="使用你喜爱的编辑编辑译文件,并保存。"/>
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="在Github Desktop仓库界面左侧栏,找到你修改的文件,并在文件左侧的方框中选中(仅选中一个文件,如要选中多个文件,请在Commit to main按钮上方的文本框输入消息)。&#xa;在右侧的文件预览中确认无误后,单击“Commit to main”(位于左侧栏的下方) "/>
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="在所有文件均提交完毕后,按下“Ctrl+P”以推送至Github。"/>
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="在窗口标题栏下方,选中“Current branch”,再在子栏底部选择“Choose a branch to merge into master”以新建拉取请求。&#xa;选中master分支,并单击子窗口下方的蓝色按钮确认"/>
+            </StackPanel>
         </local:MyCard>
-        <local:MyCard Title="在VSCode中推送代码" Margin="0,0,0,15" CanSwap="True" IsSwaped="True">
-        <StackPanel Margin="25,40,23,15">
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="在主界面按下“F1”键,输入“Git Clone”。&#xa;复制你Fork的仓库地址,粘贴到文本框以Clone。"/>
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="完成后,刚才选择的文件夹中会生成名为 PCL2Help 的子文件夹。 将 PCL2Help 文件夹中的内容剪切到 PCL\Help 中。"/>
-            <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                       Text="最后,点击左边栏 → 源代码管理 → 打开文件夹,选择 Help 文件夹即可。 此时在 VSCode 打开任意文件,你若能在左下角的时间线中查看到该文件的变更记录,就代表你已经正确完成了帮助库获取。"/>
-         <local:MyHint Margin="0,0,0,15" Text="注意,在剪切后 .git 文件夹必须位于 PCL\Help,而不能在 PCL\Help\PCL2Help 子文件夹中。" />
-         <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
-                    Text="在获取帮助库后,你就可以按照正常自定义帮助的方式对帮助库进行修改了,修改后提交 Pull Request 即可。"/>
-        </StackPanel>
+        <local:MyCard Title="使用 VSCode 获取帮助库" Margin="0,0,0,15" CanSwap="True" IsSwaped="True">
+            <StackPanel Margin="25,40,23,15">
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="如果你使用的是VSCode,则你还需要安装Git,VSCode将在右下方信息栏提示你安装,按照VSCode的引导安装即可。"/>
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="在主界面按下“F1”键,输入“Git Clone”。&#xa;复制你Fork的仓库地址,粘贴到文本框以Clone。"/>
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="完成后,刚才选择的文件夹中会生成名为 PCL2Help 的子文件夹。 将 PCL2Help 文件夹中的内容剪切到 PCL\Help 中。"/>
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="最后,点击左边栏 → 源代码管理 → 打开文件夹,选择 Help 文件夹即可。 此时在 VSCode 打开任意文件,你若能在左下角的时间线中查看到该文件的变更记录,就代表你已经正确完成了帮助库获取。"/>
+                <local:MyHint Margin="0,0,0,15" Text="注意,在剪切后 .git 文件夹必须位于 PCL\Help,而不能在 PCL\Help\PCL2Help 子文件夹中。" />
+                <TextBlock TextWrapping="Wrap" Margin="0,0,0,4" LineHeight="17"
+                           Text="在获取帮助库后,你就可以按照正常自定义帮助的方式对帮助库进行修改了,修改后提交 Pull Request 即可。"/>
+            </StackPanel>
         </local:MyCard>
     </StackPanel>
 </local:MyCard>