You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: server/documents/introduction/advanced-usage.html.eco
+8Lines changed: 8 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ type : 'Introduction'
16
16
<div class="no example">
17
17
<h4>Importing Gulp Tasks</h4>
18
18
<p>You don't have to use <a href="/introduction/build-tools.html">our gulp pipeline</a>, just import the task into your own <code>gulpfile</code></p>
19
+
<p>You can <a href="https://github.com/Semantic-Org/Example-External-Gulpfile" target="_blank">fork this example project</a> to see an example of how to import Semantic UI tasks into your project.</p>
<h2 class="ui dividing header">Prototyping with Semantic UI</h2>
33
+
<div class="no example">
34
+
<h4>Sketch Files</h4>
35
+
<p>If you are looking to prototype layouts using <a href="http://bohemiancoding.com/sketch/" target="_blank">Sketch</a> with Semantic UI check out <a href="https://github.com/guacamoly/semantic-ui-kit-for-sketch" target="_blank">Semantic UI Sketch Files</a></p>
Copy file name to clipboardExpand all lines: server/documents/introduction/build-tools.html.eco
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -302,4 +302,9 @@ type : 'Introduction'
302
302
<p>You can learn more about <code>theme.config</code> by checking out the <a href="/usage/theming.html#using-packaged-themes">theming guide</a></p>
303
303
</div>
304
304
305
+
<div class="no example">
306
+
<h4>Importing Gulp Tasks</h4>
307
+
<p>See our <a href="/introduction/advanced-usage.html">recipes section</a> for examples on how to import individual gulp tasks into your custom Gulpfile.</p>
<p>Although <a href="http://www.ubuntuupdates.org/ppa/chris_lea_nodejs" target="_blank">Chris Lea's PPA</a> was once the best way to install node, it is now somewhat out of date.</p>
61
+
<p>The recommended path to install Semantic UI is using <a href="https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager" target="_blank">Joyent's package manager</a> guide.</p>
<p>Semantic UI uses <a href="http://www.gulpjs.com" target="_blank">Gulp</a> to provide command line tools for building themed versions of the library with just the components you need.</p>
88
+
<p>Gulp is an NPM module and must be installed globally</p>
89
+
<div class="ignored code" data-type="bash">
90
+
npm install -g gulp
91
+
</div>
92
+
</div>
93
+
79
94
<div class="no example">
80
95
<h4>Install Semantic UI</h4>
81
96
<p>Semantic UI is available in an eponymous package on NPM</p>
97
+
<div class="ui ignored warning message">
98
+
If you experience issues with install hanging after setup, hold tight <a href="https://github.com/Semantic-Org/Semantic-UI/issues/2086#issuecomment-123771843">a fix is on the way</a> shortly
Copy file name to clipboardExpand all lines: server/documents/introduction/glossary.html.eco
+39-6Lines changed: 39 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -16,31 +16,32 @@ type : 'Introduction'
16
16
17
17
<div class="no example">
18
18
<h4>Types of Components</h4>
19
-
<p>The following table helps differentiate between different types of components in Semantic UI's documentation</p>
19
+
<p>Semantic UI classifies components into different definition types depending on its qualities. Each of these five types uses a unique definition format.</p>
20
20
<table class="ui large very padded definition table">
21
21
<tbody>
22
22
<tr>
23
23
<td class="three wide">Globals</td>
24
24
<td>
25
25
Globals are styles that are applied across a site. These include things like css resets, and sitewide font, link and sizing defaults.</p>
26
-
<p>Most importantly, globals include site-wide theming variables that other components can inherit and modify.</td>
26
+
<p>Most importantly, globals include site-wide <a href="/usage/theming.html">theming variables</a> that other components can inherit and modify.</td>
27
27
</tr>
28
28
</tr>
29
29
<tr>
30
30
<td>Element</td>
31
31
<td>
32
-
UI elements are page elements with a single function. They can exist alone or in a plural form with elements sharing qualities.</td>
32
+
UI elements are page elements with a single function. They can exist alone or in a plural form with elements sharing qualities.</p>
33
+
<p>For example, a group of <a href="/elements/button.html">buttons</a> may use <code>ui red buttons</code> as a grouping with individual <code>ui button</code> children.</td>
33
34
</tr>
34
35
<tr>
35
36
<td>Collection</td>
36
37
<td>
37
-
<p>Collections are heterogenous groups of components which are usually found together. They describe a list of "usual suspects" which appear in a certain context. They may include and extend other ui elements for use in certain contexts—for example form may extend ui dropdown or input—as well as include their own content.</p>
38
+
<p>Collections are heterogenous groups of components which are usually found together. They describe a list of "usual suspects" which appear in a certain context. They may include and extend other ui elements for use in certain contexts—for example <a href="/collections/form.html">form</a> may extend <a href="/modules/dropdown.html">dropdown</a> or <a href="/elements/input.html">input</a>—as well as include their own content.</p>
38
39
</td>
39
40
</tr>
40
41
<tr>
41
42
<td>Views</td>
42
43
<td>
43
-
<p>A view is a convention for presenting specific types of content that is usually consistent across a website. These include things like comments, user activity feeds, or cards.</p>
44
+
<p>A view is a convention for presenting specific types of content that is usually consistent across a website. These include things like <a href="/views/comment.html">comments</a>, <a href="/views/feed.html">activity feeds</a>, or <a href="/views/card.html">cards</a>.</p>
44
45
</td>
45
46
</tr>
46
47
<tr>
@@ -59,9 +60,41 @@ type : 'Introduction'
59
60
</table>
60
61
</div>
61
62
63
+
<div class="no example">
64
+
<h4>Project Terminology</h4>
65
+
<p>Semantic UI classifies components into separate definition groupings.<p>
66
+
67
+
<table class="ui large very padded definition table">
68
+
<tbody>
69
+
<tr>
70
+
<td class="three wide">Component</td>
71
+
<td>
72
+
A component is a general term used to refer to any user interface element packaged for distribution.
73
+
</td>
74
+
</tr>
75
+
<tr>
76
+
<td>Definition</td>
77
+
<td>
78
+
<p>A definition is a set of css and javascript which describe a component's essential qualities.</p>
79
+
<p>Definition use variables to express arbitrary parts of a component's appearance so that they can be changed with themes.</p>
80
+
</td>
81
+
</tr>
82
+
<tr>
83
+
<td>ui</td>
84
+
<td>
85
+
<p><code>ui</code> is a special class name used to distinguish parts of components from components.</p>
86
+
<p>For example, a <a href="/elements/list.html">list</a> will receive the class <code>ui list</code> because it has a corresponding definition, however a list item, will receive just the class <code>item</code>.</p>
87
+
<p>The ui class name helps encapsulate css rules by making sure all 'parts of a component' are defined in context to a 'whole' component.</p>
88
+
<p>It also helps make scanning unknown code simpler. If you see <code>ui</code> you know you are looking at a component.</p>
89
+
</td>
90
+
</tr>
91
+
</tbody>
92
+
</table>
93
+
</div>
94
+
62
95
<div class="no example">
63
96
<h4>Definition Terminology</h4>
64
-
<p>When browsing Semantic UI definitions, you will see content grouped into different sections. These are parts of a definition which generally remain consistent between components<p>
97
+
<p>When browsing Semantic UI definitions, you will see content grouped into different sections. These parts of a definition are consistent across definitions, and are common patterns for describing components.<p>
65
98
66
99
<table class="ui large very padded definition table">
Copy file name to clipboardExpand all lines: server/documents/modules/tab.html.eco
+5-22Lines changed: 5 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -364,35 +364,18 @@ themes : ['Default']
364
364
<h4>Using HTML5 State</h4>
365
365
<p>For sites that are able to replicate change on the server, tab can automatically map changes in tab navigation to <a href="http://diveintohtml5.info/history.html" target="_blank">html5 state.</a>
366
366
</p>
367
-
<div class="ui ignored info message">
368
-
Since these docs are statically hosted on GitHub Pages, html state is not supported. The following example will cause a "not found" error on page refresh.
367
+
<div class="ui ignored warning message">
368
+
Since these docs are statically hosted on GitHub Pages, html5 state tabs are not demonstratable from the docs. You will need to try this example in your own code.
0 commit comments