Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Alec committed Oct 19, 2023
1 parent 2930e97 commit cb50fc2
Show file tree
Hide file tree
Showing 11 changed files with 28 additions and 16 deletions.
10 changes: 8 additions & 2 deletions _sources/content/Wiki/en_qgis_projects_folder_structure_wiki.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# QGIS manage Projects and Geodata
# Projects and Folder Structure

In this wiki article, best practices for the creation and management of QGIS projects and geodata is presented.

## Step-by-step: Setting up a new QGIS project from scratch

```{Tip}
It is good practice to use a standardized folder structure for QGIS projects in which the project, all used geodata, styling files and documentation is stored
It is good practice to use a __standard folder structure__ for QGIS projects in which the project, all used geodata, styling files and documentation is stored
```

1. Copy the standard folder structure for QGIS projects to the place you want to store your whole project. You can download the standard folder structure *here*.
Expand Down Expand Up @@ -47,5 +47,11 @@ __Open QGIS Project__

## Standard Folder Structure

The standard folder structure has two principal advantages:
1. By sharing the whole project folder, we can be certain that the project will run without problems on a different computer.
2. The folder structure supports the proper organization of geodata and supports the stable function of a QGIS project.

The folder structure template can be downloaded [__here__](/fig/GIS_Project_folder_template.zip).

![](/fig/Standard_project_folder_structure.drawio.svg)

2 changes: 1 addition & 1 deletion content/Modul_4/en_qgis_map_design_2.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<li class="toctree-l1 has-children"><a class="reference internal" href="../Wiki/en_qgis_qgis_basics_wiki.html">QGIS Basics</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_installation_wiki.html">QGIS installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_interface_wiki.html">QGIS Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projects_folder_structure_wiki.html">QGIS manage Projects and Geodata</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projects_folder_structure_wiki.html">Projects and Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projections_wiki.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_basemaps_wiki.html">Basemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_plugins_wiki.html">Plugins</a></li>
Expand Down
2 changes: 1 addition & 1 deletion content/Modul_4/en_qgis_map_design_I.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<li class="toctree-l1 has-children"><a class="reference internal" href="../Wiki/en_qgis_qgis_basics_wiki.html">QGIS Basics</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_installation_wiki.html">QGIS installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_interface_wiki.html">QGIS Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projects_folder_structure_wiki.html">QGIS manage Projects and Geodata</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projects_folder_structure_wiki.html">Projects and Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projections_wiki.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_basemaps_wiki.html">Basemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_plugins_wiki.html">Plugins</a></li>
Expand Down
2 changes: 1 addition & 1 deletion content/Modul_4/en_qgis_map_design_I_ex1.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<li class="toctree-l1 has-children"><a class="reference internal" href="../Wiki/en_qgis_qgis_basics_wiki.html">QGIS Basics</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_installation_wiki.html">QGIS installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_interface_wiki.html">QGIS Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projects_folder_structure_wiki.html">QGIS manage Projects and Geodata</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projects_folder_structure_wiki.html">Projects and Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_projections_wiki.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_basemaps_wiki.html">Basemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="../Wiki/en_qgis_plugins_wiki.html">Plugins</a></li>
Expand Down
18 changes: 12 additions & 6 deletions content/Wiki/en_qgis_projects_folder_structure_wiki.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<title>QGIS manage Projects and Geodata &#8212; GIS Resource Training Center</title>
<title>Projects and Folder Structure &#8212; GIS Resource Training Center</title>



Expand Down Expand Up @@ -171,7 +171,7 @@
<li class="toctree-l1 current active has-children"><a class="reference internal" href="en_qgis_qgis_basics_wiki.html">QGIS Basics</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="en_qgis_installation_wiki.html">QGIS installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_interface_wiki.html">QGIS Interface</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">QGIS manage Projects and Geodata</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Projects and Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_projections_wiki.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_basemaps_wiki.html">Basemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_plugins_wiki.html">Plugins</a></li>
Expand Down Expand Up @@ -453,7 +453,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>QGIS manage Projects and Geodata</h1>
<h1>Projects and Folder Structure</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -477,14 +477,14 @@ <h2> Contents </h2>
<div id="searchbox"></div>
<article class="bd-article" role="main">

<section class="tex2jax_ignore mathjax_ignore" id="qgis-manage-projects-and-geodata">
<h1>QGIS manage Projects and Geodata<a class="headerlink" href="#qgis-manage-projects-and-geodata" title="Permalink to this heading">#</a></h1>
<section class="tex2jax_ignore mathjax_ignore" id="projects-and-folder-structure">
<h1>Projects and Folder Structure<a class="headerlink" href="#projects-and-folder-structure" title="Permalink to this heading">#</a></h1>
<p>In this wiki article, best practices for the creation and management of QGIS projects and geodata is presented.</p>
<section id="step-by-step-setting-up-a-new-qgis-project-from-scratch">
<h2>Step-by-step: Setting up a new QGIS project from scratch<a class="headerlink" href="#step-by-step-setting-up-a-new-qgis-project-from-scratch" title="Permalink to this heading">#</a></h2>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>It is good practice to use a standardized folder structure for QGIS projects in which the project, all used geodata, styling files and documentation is stored</p>
<p>It is good practice to use a <strong>standard folder structure</strong> for QGIS projects in which the project, all used geodata, styling files and documentation is stored</p>
</div>
<ol class="arabic simple">
<li><p>Copy the standard folder structure for QGIS projects to the place you want to store your whole project. You can download the standard folder structure <em>here</em>.</p></li>
Expand Down Expand Up @@ -520,6 +520,12 @@ <h2>Open existing QGIS Projects<a class="headerlink" href="#open-existing-qgis-p
</section>
<section id="standard-folder-structure">
<h2>Standard Folder Structure<a class="headerlink" href="#standard-folder-structure" title="Permalink to this heading">#</a></h2>
<p>The standard folder structure has two principal advantages:</p>
<ol class="arabic simple">
<li><p>By sharing the whole project folder, we can be certain that the project will run without problems on a different computer.</p></li>
<li><p>The folder structure supports the proper organization of geodata and supports the stable function of a QGIS project.</p></li>
</ol>
<p>The folder structure template can be downloaded <span class="xref myst"><strong>here</strong></span>.</p>
<p><img alt="" src="../../_images/Standard_project_folder_structure.drawio.svg" /></p>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion content/Wiki/en_qgis_qgis_basics_wiki.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">QGIS Basics</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_installation_wiki.html">QGIS installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_interface_wiki.html">QGIS Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_projects_folder_structure_wiki.html">QGIS manage Projects and Geodata</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_projects_folder_structure_wiki.html">Projects and Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_projections_wiki.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_basemaps_wiki.html">Basemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="en_qgis_plugins_wiki.html">Plugins</a></li>
Expand Down
2 changes: 1 addition & 1 deletion content/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@
<li class="toctree-l1 has-children"><a class="reference internal" href="Wiki/en_qgis_qgis_basics_wiki.html">QGIS Basics</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="Wiki/en_qgis_installation_wiki.html">QGIS installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="Wiki/en_qgis_interface_wiki.html">QGIS Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="Wiki/en_qgis_projects_folder_structure_wiki.html">QGIS manage Projects and Geodata</a></li>
<li class="toctree-l2"><a class="reference internal" href="Wiki/en_qgis_projects_folder_structure_wiki.html">Projects and Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="Wiki/en_qgis_projections_wiki.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="Wiki/en_qgis_basemaps_wiki.html">Basemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="Wiki/en_qgis_plugins_wiki.html">Plugins</a></li>
Expand Down
2 changes: 1 addition & 1 deletion genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@
<li class="toctree-l1 has-children"><a class="reference internal" href="content/Wiki/en_qgis_qgis_basics_wiki.html">QGIS Basics</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_installation_wiki.html">QGIS installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_interface_wiki.html">QGIS Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_projects_folder_structure_wiki.html">QGIS manage Projects and Geodata</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_projects_folder_structure_wiki.html">Projects and Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_projections_wiki.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_basemaps_wiki.html">Basemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_plugins_wiki.html">Plugins</a></li>
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion search.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@
<li class="toctree-l1 has-children"><a class="reference internal" href="content/Wiki/en_qgis_qgis_basics_wiki.html">QGIS Basics</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_installation_wiki.html">QGIS installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_interface_wiki.html">QGIS Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_projects_folder_structure_wiki.html">QGIS manage Projects and Geodata</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_projects_folder_structure_wiki.html">Projects and Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_projections_wiki.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_basemaps_wiki.html">Basemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="content/Wiki/en_qgis_plugins_wiki.html">Plugins</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit cb50fc2

Please sign in to comment.