512
edits
Changes
Technology Trends/User Guide (view source)
Revision as of 14:11, 26 August 2019
, 14:11, 26 August 2019no edit summary
</div><br><br>
</div><br><br>
<h2>Set up</h2>
<h2>Initialization and Configuration</h2>
<h3>Code Editors</h3>
<h3>Getting a GCcollab account</h3>
<p>Since most of the codes a publisher will have to write is in HTML and CSS, it is highly recommended the use of a Code Editor. Below are some examples and we recommend Visual Studio Code.</p>
<p>Before starting to code, you will need an account on [https://gccollab.ca/ GCcollab] in order to create and edit existing GCwiki source code. If you have an Governmenet of Canada email account the process should be simple. If not, a public servant with an existing account can invite you using the invite button located at the top of the dashboard.</p>
<h3>Installing a Code Editor</h3>
<p>Most of the code written on the technology trend page is done in HTML and CSS since they were found to be the easiest and offer versatily when it comes to styling. Therefore, it is highly recommended that you use a Code Editor for the publishing process. They are not obligatory for the purpose of publishing technology trend. However, they simplify and accelerate the process. Below are three of the most popular environment and should be sufficient for the process. These platforms offer important tools and features such as syntax highlighting, file explorers, console, etc. Since Visual Studio Code is currently the most popular choice, examples in this user guide will use this editor, however the process is similar with others.</p>
<ul>
<li><b>[https://code.visualstudio.com/ Visual Studio Code] : </b>A completed editor where all the tools are available after installation.</li>
<li><b>[https://atom.io/ Atom] : </b>A simple and lightweight editor where most features are avaiable as packages and can be installed throught the settings.</li>
<li><b>[https://www.sublimetext.com/ Sublime Text] : </b>A classic editor offering the barebones functionnality.</li>
</ul>
<h3>Initializing the Code Editor</h3>
<p>After installing the editor, follow these following steps to start creating your first file. For this example, we will be using Visual Studio Code but the process is similar on other platforms.</p>
<ul>
<li><b>Creating a Workspace folder</b> : A workspace is a project folder located on your local computer that contains all of the project code. Locate a suitable directory on your computer a create an empty folder with an appropriate name (such as "GCwiki").</li>
<li><b>Adding the folder to the Editor's workspace</b> : On Visual Studio, open the file explorer located on the left or by pressing Ctrl+Shift+E. Right click on the Workspace portion and click "Add Folder to Workspace". Locate and select the previously created folder as your new workspace.</li>
<li><b>Creating a new file</b> : Right click on the project folder "GCwiki" and select new file. Enter an appropriate filename with an ending of ".html" such as "EN - Example.html". Use this newly created file to write all the code for the technology brief.</li>
<li><b>Adding the template's code</b> : Navigate to the [https://wiki.gccollab.ca/Technology_Trends template] page. On the upper navigation bar, select "view source" or, if you are logged in, "edit source". From there, copy and paste the [https://wiki.gccollab.ca/Technology_Trends template]'s code to your file. This template offers all the technology brief empty code.</li>
<li><b>Adjusting the template's code</b> : Before starting to publish the technology brief content, you need to adjust the template's information. All comments in the brackets "<!-- comment --> need to be replace by the corresponding information. Don't forget to use the underscore (_) when using links and files</li>
</ul>
<h3>Publishing on GCwiki</h3>
<p>During the technology trend publishing process, it is important to view how to code is being </p>
<ul>
<li><b>Creating a new page</b> : To create a new page on GCwiki, you simply have to enter the corresponding name in the URL bar on top of your browser. For example : the link for the this user guide is "https://wiki.gccollab.ca/Technology_Trends/User_Guide". The platform will offer you the option the create the corresponding page. Warning! Once a page has been created, it cannot be deleted so enter a valid name that follows the standards. For english page, name's starts with "Technology_Trends/" followed by the technology name using underscores rather than space. For french page, use "Tendances_Technologiques/" followed by the same structure.</li>
<li><b>Adding the code</b> : Navigate to the "Edit Source" tab on top of the page to publish your code. Copy and paste the corresponding code from Visual Studio Code to GCwiki. Pres "Save changes" to publish or "Show preview" to view the resulting code.</li>
</ul>
<h3>GCwiki Standards and Norms</h3>
<ul>
<li><b></b></li>
</ul>
<h3>Visual Studio Code : Settings and Shortcuts</h3>
<p>Here are some settings configuration</p>
<ul>
<li><b>Autocomplete</b> : </li>
</ul>
<p>Here are some shortcuts to accelerate your process.</p>
<ul>
<ul>
<li><b>[[https://code.visualstudio.com/|Visual Studio Code]] : </b>A completed </li>
<li><b>Autocomplete</b> : </li>
</ul>
</ul>
<h3>Creating a page</h3>
<h2>Code Tutorial</h2>
<h2>Technology Brief</h2>
<h2>Technology Brief</h2>