index.html 11.1 KB
Newer Older
Jonathan Carter's avatar
Jonathan Carter committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<!DOCTYPE html>
  
  
  
  
   <html class="no-js"> 

  <head lang="en-us">
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
    <meta http-equiv="X-UA-Compatible" content="IE=10" />
    <title>Adding content - AIMS Desktop</title>
    <meta name="generator" content="Hugo 0.18.1" />

    
    <meta name="description" content="A material design theme for documentations.">
    
    <link rel="canonical" href="https://desktop.aims.ac.za/adding-content/">
    
    <meta name="author" content="Digitalcraftsman">
    

    <meta property="og:url" content="https://desktop.aims.ac.za/adding-content/">
    <meta property="og:title" content="AIMS Desktop">
    <meta property="og:image" content="https://desktop.aims.ac.za/images/logo.png">
    <meta name="apple-mobile-web-app-title" content="AIMS Desktop">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">

    <link rel="shortcut icon" type="image/x-icon" href="https://desktop.aims.ac.za/images/favicon.ico">
    <link rel="icon" type="image/x-icon" href="https://desktop.aims.ac.za/images/favicon.ico">

    <style>
      @font-face {
        font-family: 'Icon';
        src: url('https://desktop.aims.ac.za/fonts/icon.eot');
        src: url('https://desktop.aims.ac.za/fonts/icon.eot')
               format('embedded-opentype'),
             url('https://desktop.aims.ac.za/fonts/icon.woff')
               format('woff'),
             url('https://desktop.aims.ac.za/fonts/icon.ttf')
               format('truetype'),
             url('https://desktop.aims.ac.za/fonts/icon.svg')
               format('svg');
        font-weight: normal;
        font-style: normal;
      }
    </style>

    <link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/application.css">
    <link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/temporary.css">
    <link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/palettes.css">
    <link rel="stylesheet" href="https://desktop.aims.ac.za/stylesheets/highlight/highlight.css">

    
    
    
    <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu&#43;Mono">
    <style>
      body, input {
        font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
      }
      pre, code {
        font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
      }
    </style>

    
    <script src="https://desktop.aims.ac.za/javascripts/modernizr.js"></script>

    

  </head>
Jonathan Carter's avatar
Jonathan Carter committed
74
  <body class="palette-primary-#fc0000 palette-accent-blue">
Jonathan Carter's avatar
Jonathan Carter committed
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125




<div class="backdrop">
	<div class="backdrop-paper"></div>
</div>

<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>

<header class="header">
	<nav aria-label="Header">
  <div class="bar default">
    <div class="button button-menu" role="button" aria-label="Menu">
      <label class="toggle-button icon icon-menu" for="toggle-drawer">
        <span></span>
      </label>
    </div>
    <div class="stretch">
      <div class="title">
        Adding content
      </div>
    </div>

    

    
    
        
  </div>
  <div class="bar search">
    <div class="button button-close" role="button" aria-label="Close">
      <label class="toggle-button icon icon-back" for="toggle-search"></label>
    </div>
    <div class="stretch">
      <div class="field">
        <input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
      </div>
    </div>
    <div class="button button-reset" role="button" aria-label="Search">
      <button class="toggle-button icon icon-close" id="reset-search"></button>
    </div>
  </div>
</nav>
</header>

<main class="main">
	<div class="drawer">
		<nav aria-label="Navigation">
Jonathan Carter's avatar
Jonathan Carter committed
126
  <a href="https://desktop.aims.ac.za/download" class="project">
Jonathan Carter's avatar
Jonathan Carter committed
127
128
129
130
131
132
133
    <div class="banner">
      
        <div class="logo">
          <img src="https://desktop.aims.ac.za/images/logo.png">
        </div>
      
      <div class="name">
Jonathan Carter's avatar
Jonathan Carter committed
134
        <strong>AIMS Desktop <span class="version">2017.1</span></strong>
Jonathan Carter's avatar
Jonathan Carter committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
        
      </div>
    </div>
  </a>

  <div class="scrollable">
    <div class="wrapper">
      

      <div class="toc">
        
        <ul>
          




<li>
  
    



Jonathan Carter's avatar
Jonathan Carter committed
158
<a  title="Welcome" href="https://desktop.aims.ac.za/">
Jonathan Carter's avatar
Jonathan Carter committed
159
	
Jonathan Carter's avatar
Jonathan Carter committed
160
	Welcome
Jonathan Carter's avatar
Jonathan Carter committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
</a>



  
</li>



<li>
  
    



<a  title="Getting started" href="https://desktop.aims.ac.za/getting-started/">
	
	Getting started
</a>



  
</li>



<li>
  
    



<a class="current" title="Adding content" href="https://desktop.aims.ac.za/adding-content/">
	
	Adding content
</a>


<ul id="scrollspy">
</ul>


  
</li>



<li>
  
    



<a  title="Roadmap" href="https://desktop.aims.ac.za/roadmap/">
	
	Roadmap
</a>



  
</li>



<li>
  
    



<a  title="License" href="https://desktop.aims.ac.za/license/">
	
	License
</a>



  
</li>


        </ul>
        

        
        <hr>
        <span class="section">The author</span>
        
        <ul>
          

          

          
          <li>
            <a href="mailto:aims-tech@aims.ac.za" title="Email of aims-tech@aims.ac.za">
              Contact via email
            </a>
          </li>
          
        </ul>
        
      </div>
    </div>
  </div>
</nav>

	</div>

	<article class="article">
		<div class="wrapper">
			<h1>Adding content </h1>

			

Jonathan Carter's avatar
Jonathan Carter committed
278
279
280
281
<h2 id="download-aims-desktop">Download AIMS Desktop</h2>

<p>&hellip;</p>

Jonathan Carter's avatar
Jonathan Carter committed
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
<h2 id="hello-world">Hello world</h2>

<p>Let&rsquo;s create our first content file for your documentation. Open a terminal and add the following command for each new file you want to add. Replace <code>&lt;section-name&gt;</code> with a general term that describes your document in detail.</p>

<pre><code class="language-sh">hugo new &lt;section-name&gt;/filename.md
</code></pre>

<p>Visitors of your website will find the final document under <code>www.example.com/&lt;section-name&gt;/filename/</code>.</p>

<p>Since it&rsquo;s possible to have multiple content files in the same section I recommend to create at least one <code>index.md</code> file per section. This ensures that users will find an index page under <code>www.example.com/&lt;section-name&gt;</code>.</p>

<h2 id="homepage">Homepage</h2>

<p>To add content to the homepage you need to add a small indicator to the frontmatter of the content file:</p>

<pre><code class="language-toml">type: index
</code></pre>

<p>Otherwise the theme will not be able to find the corresponding content file.</p>

<h2 id="table-of-contents">Table of contents</h2>

<p>You maybe noticed that the menu on the left contains a small table of contents of the current page. All <code>&lt;h2&gt;</code> tags (<code>## Headline</code> in Markdown) will be added automatically.</p>

<h2 id="admonitions">Admonitions</h2>

<p>Admonition is a handy feature that adds block-styled side content to your documentation, for example hints, notes or warnings. It can be enabled by using the corresponding <a href="http://gohugo.io/extras/shortcodes/">shortcodes</a> inside your content:</p>

<pre><code class="language-go">{{&lt; note title=&quot;Note&quot; &gt;}}
Nothing to see here, move along.
{{&lt; /note &gt;}}
</code></pre>

<p>This will print the following block:</p>

<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Nothing to see here, move along.</p>
</div>

<p>The shortcode adds a neutral color for the note class and a red color for the warning class. You can also add a custom title:</p>

<pre><code class="language-go">{{&lt; warning title=&quot;Don't try this at home&quot; &gt;}}
Nothing to see here, move along.
{{&lt; /warning &gt;}}
</code></pre>

<p>This will print the following block:</p>

<div class="admonition warning">
<p class="admonition-title">Don&#39;t try this at home</p>
<p>Nothing to see here, move along.</p>
</div>


			<aside class="copyright" role="note">
				
				&copy; 2017 Released under the MIT license &ndash;
				
				Documentation built with
				<a href="https://www.gohugo.io" target="_blank">Hugo</a>
				using the
				<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
			</aside>

			<footer class="footer">
				

<nav class="pagination" aria-label="Footer">
  <div class="previous">
  
      <a href="https://desktop.aims.ac.za/getting-started/" title="Getting started">
        <span class="direction">
          Previous
        </span>
        <div class="page">
          <div class="button button-previous" role="button" aria-label="Previous">
            <i class="icon icon-back"></i>
          </div>
          <div class="stretch">
            <div class="title">
              Getting started
            </div>
          </div>
        </div>
      </a>
  
  </div>

  <div class="next">
  
      <a href="https://desktop.aims.ac.za/roadmap/" title="Roadmap">
        <span class="direction">
          Next
        </span>
        <div class="page">
          <div class="stretch">
            <div class="title">
              Roadmap
            </div>
          </div>
          <div class="button button-next" role="button" aria-label="Next">
            <i class="icon icon-forward"></i>
          </div>
        </div>
      </a>
  
  </div>
</nav>





			</footer>
		</div>
	</article>

	<div class="results" role="status" aria-live="polite">
		<div class="scrollable">
			<div class="wrapper">
				<div class="meta"></div>
				<div class="list"></div>
			</div>
		</div>
	</div>
</main>

    <script>
    
Jonathan Carter's avatar
Jonathan Carter committed
412
413
      var base_url = '';
      var repo_id  = '';
Jonathan Carter's avatar
Jonathan Carter committed
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
    
    </script>

    <script src="https://desktop.aims.ac.za/javascripts/application.js"></script>
    

    <script>
      /* Add headers to scrollspy */
      var headers   = document.getElementsByTagName("h2");
      var scrollspy = document.getElementById('scrollspy');

      if(scrollspy) {
        if(headers.length > 0) {
          for(var i = 0; i < headers.length; i++) {
            var li = document.createElement("li");
            li.setAttribute("class", "anchor");

            var a  = document.createElement("a");
            a.setAttribute("href", "#" + headers[i].id);
            a.setAttribute("title", headers[i].innerHTML);
            a.innerHTML = headers[i].innerHTML;

            li.appendChild(a)
            scrollspy.appendChild(li);
          }
        } else {
          scrollspy.parentElement.removeChild(scrollspy)
        }


        /* Add permanent link next to the headers */
        var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");

        for(var i = 0; i < headers.length; i++) {
            var a = document.createElement("a");
            a.setAttribute("class", "headerlink");
            a.setAttribute("href", "#" + headers[i].id);
            a.setAttribute("title", "Permanent link")
            a.innerHTML = "#";
            headers[i].appendChild(a);
        }
      }
    </script>

    

    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
    <script>hljs.initHighlightingOnLoad();</script>
  </body>
</html>