Skip to content
GitLab
Commit afe9960f authored by Athanasios's avatar Athanasios
Browse files

Update pages help

parent d1628f63
Hide whitespace changes
Inline Side-by-side
Showing
with 75 additions and 22 deletions
+75 -22
help/gitlab-pages.html
+ 75
- 22
View file @ afe9960f
......@@ -75,17 +75,6 @@
<li>
Ihr Projekt wird nun erstellt und enthält automatisch die notwendigen Grundeinstellungen für das Publizieren einer Website über die Funktion Pages. Vor allem wird im Repositorium der Ordner <em> Public </em> angelegt.
<img src="/img/help/folderpublic.png" width="95%"/> <br/>
<p> This is the structure of a simple template.</p>
<p><em>assets</em> folder: You place in this folder files that should be common for all the subpages of your gitlab page. E.g. you should place any personal avatars or partner logos in the corresponding folders (images, logos).</p>
<p><em>home</em> folder: This is the default folder where you place your main template.</p>
<p><em>settings.js</em>: This is the file where you select the settings for your gitlab page.</p>
<img src="/img/help/content_public.jpg"/>
<p>You should not make changes to some of the files.</p>
<p>Red: Those files should not be changed.</p>
<p>Orange: Those files should be replaced by your own files. The filename should remain the same.</p>
<p>Green: Those files you can edit.</p>
<p>Blue: In those folders you can add your additional files. In case of assets, images, logos etc. In case of a template folder, your custom css, javascript or any other files.</p>
<img src="/img/help/content_public_colors.jpg"/>
</li>
<li>
Um Ihre eigenen Projektinhalte zu veröffentlichen, können Sie entweder eine komplett eigene HTML-Seite erzeugen oder sich an unseren Vorgaben aus dem Template orientieren. Eine Anleitung zur Verwendung unserer Vorlage finden Sie im Bereich <a href="#template_Text">Gitlab-pages Template benutzen</a>
......@@ -222,6 +211,20 @@
</h3>
</div>
<div id="collapse3" class="card-body collapse">
<p>
A template can be a single page or it can be multiple pages with a menu to select them.
If the name of a template begins with the word "simple" then it is a single page template. This is the general structure of a template:
</p>
<img src="/img/help/content_public.jpg"/>
<p><em>assets</em> folder: You place in this folder files that should be common for the single page or all the pages of your gitlab template. E.g. you should place any personal avatars or partner logos in the corresponding folders (images, logos).</p>
<p><em>home</em> folder: This is the default folder where you place your main page (think of it as the landing page).</p>
<p><em>settings.js</em>: This is the file where you select the settings for your gitlab page.</p>
<p>You should not make changes to some of the files.</p>
<img src="/img/help/content_public_colors.jpg"/>
<p>Red: Those files should not be changed.</p>
<p>Orange: Those files should be replaced by your own files. The filename should remain the same. If there are files that should be replaced depends on the template you choose.</p>
<p>Green: Those files you can edit.</p>
<p>Blue: In those folders you can add your additional files. In case of assets, images, logos etc. In case of a template folder, your custom css, javascript or any other files.</p>
<p>
Um unsere Vorlage zu benutzen, müssen Sie folgende Schritte ausführen:
</p>
......@@ -239,6 +242,8 @@
<img src="/img/help/default_settings.png"/>
<p>The switches control which parts of you gitlab page should turn on or off. E.g. if you want a single page and not a menu then you change the menu value to OFF.</p>
<img src="/img/help/switches.png"/>
<p>Here you change the project logo. The logo will appear centered at the top of the page. If the switch for the project logo is OFF then it will not be visible.</p>
<img src="/img/help/pr_logo.png"/>
<p>Here you change the project name. If the switch for the project name is OFF then it will not be visible.</p>
<img src="/img/help/pr_name.png"/>
<p>Here you change the menu of your gitlab page. A menu can be linked with a folder/template or with an external link, e.g. a demo. You can add or remove menu entries. You hide the menu when the switch is OFF.
......@@ -257,14 +262,6 @@
Here you change the footer logos of a project's partners. If you don't want a logo to link to an external website then use the href value EMPTY_LINK. The title will appear when you hover the mouse over a logo.
</p>
<img src="/img/help/f_logos.png"/>
<p>
When you use the generic template there is an additional folder called templates. Inside this folder you will find all the available templates.
In order to use a template, you have to copy the folder from templates/&lttemplate name&gt and paste it (when you edit your pages locally) in the root folder.
Then it’s a good practice to rename this folder with the menu text you want to link it. Notice that the home page always points to the home folder.
That means if you want to use a template as home page then you have to rename the folder to home.
</p>
<img src="/img/help/generic.png"/>
<p>
Klicken Sie anschließend auf <em> commit changes </em>, um die Änderungen zu speichern.
</p>
......@@ -311,12 +308,17 @@
<p> Um ein eigenes Projektlogo zum Projekt hinzuzufügen, müssen Sie folgende Schritte ausführen:
<ol>
<li>
Öffnen Sie den Ordner <em> public </em>
Öffnen Sie den Ordner <em> public/assets/logos </em>
</li>
<li>
Klicken Sie auf das + im Oberen Bereich, und anschließend auf <em> Upload File </em>
<img src="/img/help/publicplus.png" width="95%"/>
</li>
<li>
<p>
The logo should be square with dimentions 300x300 pixels
</p>
</li>
<li>
Fügen Sie die gewünschte Datei hinzu und klicken Sie auf <em> Upload File </em>
<img src="/img/help/upload_logo.png" width="95%"/>
......@@ -324,9 +326,9 @@
<li>
Öffnen Sie nun im Ordner <em> public </em> die Datei <em> settings.js </em> und editieren diese.
<p>
In der Zeile mit <em>projektlogourl</em> schreiben Sie nun ./DATEINAME in die Anführungszeichen, um den Pfad zum Logo anzugeben. Ein Klick auf <em> Commit changes </em> speichert die Datei.
In der Zeile mit <em>projectLogo</em> schreiben Sie nun DATEINAME in die Anführungszeichen, um den Pfad zum Logo anzugeben. Ein Klick auf <em> Commit changes </em> speichert die Datei.
</p>
<img src="/img/help/settings_logo.png" width="95%"/>
<img src="/img/help/pr_logo.png"/>
</li>
<li>
Nun erscheint auf all Ihren Seiten das Projektlogo neben dem Logo der Hochschule.
......@@ -374,6 +376,57 @@
</p>
</div>
</div>
<br/>
<div class="card">
<div class="card-header">
<h3 class="card-title">
<a class="collapsed" data-toggle="collapse" href="#collapse7" aria-expanded="false" aria-controls="collapse7">
<small>simple_raw template</small></a>
</h3>
</div>
<div id="collapse7" class="card-body collapse">
<p>This is a single page template with arbitrary content. In order to change the contents you have to edit the index.html file.</p>
</div>
</div>
<br/>
<div class="card">
<div class="card-header">
<h3 class="card-title">
<a class="collapsed" data-toggle="collapse" href="#collapse8" aria-expanded="false" aria-controls="collapse8">
<small>simple_thesis template</small></a>
</h3>
</div>
<div id="collapse8" class="card-body collapse">
<p>
This is a single page template for a thesis. Inside the home folder you have to replace the files with the cover of your thesis and the actual thesis file.
Then you have to edit the index.html file and replace your name, year, etc.
</p>
</div>
</div>
<br/>
<div class="card">
<div class="card-header">
<h3 class="card-title">
<a class="collapsed" data-toggle="collapse" href="#collapse9" aria-expanded="false" aria-controls="collapse9">
<small>generic template</small></a>
</h3>
</div>
<div id="collapse9" class="card-body collapse">
<p>
When you use the generic template there is an additional folder called templates. Inside this folder you will find all the available templates.
In order to use a template, you have to copy the folder from templates/&lttemplate name&gt and paste it (when you edit your pages locally) in the root folder.
Then it’s a good practice to rename this folder with the menu text you want to link it. Notice that the home page always points to the home folder.
That means if you want to use a template as home page then you have to rename the folder to home.
</p>
<img src="/img/help/generic.png"/>
</div>
</div>
</div>
</div>
</div>
......
img/help/pr_logo.png 0 → 100644
+ 0
- 0
View file @ afe9960f
img/help/pr_logo.png

2.29 KB

img/help/settings_logo.png deleted 100644 → 0
+ 0
- 0
View file @ d1628f63
img/help/settings_logo.png

87.2 KB

img/help/switches.png
+ 0
- 0
View replaced file @ d1628f63 View file @ afe9960f
img/help/switches.png

7.67 KB | W: 0px | H: 0px

img/help/switches.png

10.4 KB | W: 0px | H: 0px

img/help/switches.png
img/help/switches.png
img/help/switches.png
img/help/switches.png
  • 2-up
  • Swipe
  • Onion skin
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Dies ist die Gitlab-Instanz des Transferportals der Hochschule für Technik Stuttgart. Hier geht es zurück zum Portal