Browse Source

Add better doc examples for header and image

pull/1177/head
jlukic 10 years ago
parent
commit
ad6ef93c86
20 changed files with 145 additions and 83 deletions
  1. 77
      server/documents/elements/header.html.eco
  2. 140
      server/documents/elements/image.html.eco
  3. 0
      server/files/images/animals/moose-love.jpg
  4. 0
      server/files/images/animals/moose.jpg
  5. 0
      server/files/images/animals/poney.jpg
  6. BIN
      server/files/images/leaves/10.png
  7. BIN
      server/files/images/wireframe/centered-paragraph.png
  8. BIN
      server/files/images/wireframe/image-square.png
  9. BIN
      server/files/images/wireframe/image-text.png
  10. BIN
      server/files/images/wireframe/image.png
  11. BIN
      server/files/images/wireframe/media-paragraph-alt.png
  12. BIN
      server/files/images/wireframe/media-paragraph.png
  13. BIN
      server/files/images/wireframe/paragraph.png
  14. BIN
      server/files/images/wireframe/short-paragraph.png
  15. BIN
      server/files/images/wireframe/square-image.png
  16. BIN
      server/files/images/wireframe/text-image.png
  17. BIN
      server/files/images/wireframe/white-image.png
  18. 2
      server/files/javascript/semantic.js
  19. 7
      server/files/stylesheets/semantic.css
  20. 2
      server/layouts/default.html.eco

77
server/documents/elements/header.html.eco

@ -26,6 +26,7 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<h2 class="ui header">
Account Settings
</h2>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
</div>
<div class="example">
@ -35,6 +36,7 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
Account Settings
<div class="sub header">Manage your account settings and set e-mail preferences.</div>
</h2>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
</div>
<div class="another example">
<h2 class="ui header">
@ -44,6 +46,7 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<div class="sub header">Manage your account settings and set e-mail preferences.</div>
</div>
</h2>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
</div>
<div class="example">
@ -56,6 +59,7 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<div class="sub header">Manage your account settings and set e-mail preferences.</div>
</div>
</h2>
<img class="ui disabled ignored image" src="/images/wireframe/centered-paragraph.png">
</div>
@ -64,20 +68,20 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<p class="header">Headers may be oriented to give the heirarchy of a section in the context of the page</p>
<div class="ignored info ui message">Page headings size themselves relative to the base font of the entire page not the surrounding text.</div>
<div class="ui ignored two fluid font buttons">
<a class="increase ui button"> <i class="icon green plus"></i> Base Font</a>
<a class="decrease ui button"> <i class="icon red minus"></i> Base Font</a>
<a class="increase ui button"> <i class="plus icon"></i> Base Font</a>
<a class="decrease ui button"> <i class="minus icon"></i> Base Font</a>
</div>
<div class="ui segment">
<div class="sizer">
<h1 class="ui header">First header</h1>
<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<h2 class="ui header">Second header</h2>
<p>Donec nec justo eget felis facilisis fermentum. Aliquam porttitor mauris sit amet orci. Aenean dignissim pellentesque felis.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<h3 class="ui header">Third header</h3>
<p>Morbi in sem quis dui placerat ornare. Pellentesque odio nisi, euismod in, pharetra a, ultricies in, diam. Sed arcu. Cras consequat.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<h4 class="ui header">Fourth header</h4>
<p>Praesent dapibus, neque id cursus faucibus, tortor neque egestas augue, eu vulputate magna eros eu erat. Aliquam erat volutpat. Nam dui mi, tincidunt quis, accumsan porttitor, facilisis luctus, metus.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<h5 class="ui header">Fifth header</h5>
<p>Phasellus ultrices nulla quis nibh. Quisque a lectus. Donec consectetuer ligula vulputate sem tristique cursus. Nam nulla quam, gravida non, commodo a, sodales sit amet, nisi.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
</div>
</div>
@ -86,20 +90,20 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<p>Headers may be oriented to give the importance of a section in the context of the content that surrounds it</p>
<div class="ignored info ui message">Content headings size themselves relative to the base font of the surrounding text</div>
<div class="ui ignored two fluid font buttons">
<a class="increase ui button"> <i class="icon green plus"></i> Base Font</a>
<a class="decrease ui button"> <i class="icon red minus"></i> Base Font</a>
<a class="increase ui button"> <i class="plus icon"></i> Base Font</a>
<a class="decrease ui button"> <i class="minus icon"></i> Base Font</a>
</div>
<div class="ui segment">
<div class="sizer">
<div class="ui huge header">Huge Header</div>
<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. Suspendisse urna nibh, viverra non, semper suscipit, posuere a, pede.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<div class="ui large header">Large Header</div>
<p>Donec nec justo eget felis facilisis fermentum. Aliquam porttitor mauris sit amet orci. Aenean dignissim pellentesque felis.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<div class="ui medium header">Medium Header</div>
<p>Morbi in sem quis dui placerat ornare. Pellentesque odio nisi, euismod in, pharetra a, ultricies in, diam. Sed arcu. Cras consequat.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<div class="ui small header">Small Header</div>
<p>Praesent dapibus, neque id cursus faucibus, tortor neque egestas augue, eu vulputate magna eros eu erat. Aliquam erat volutpat. Nam dui mi, tincidunt quis, accumsan porttitor, facilisis luctus, metus.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<div class="ui tiny header">Tiny Header</div>
<p>Phasellus ultrices nulla quis nibh. Quisque a lectus. Donec consectetuer ligula vulputate sem tristique cursus. Nam nulla quam, gravida non, commodo a, sodales sit amet, nisi.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
</div>
</div>
@ -111,6 +115,7 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<div class="ui disabled header">
Disabled Header
</div>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
</div>
<h2 class="ui dividing header">Variations</h2>
@ -119,12 +124,11 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<div class="example">
<h4 class="ui header">Dividing</h4>
<p>A header can be formatted to divide itself from the content below it</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
<h3 class="ui dividing header">
The nature of dogs
Dividing Header
</h3>
<p>Understanding how dogs behave in nature can help us to better fulfill their needs when we bring them into our homes.</p>
<p>When a puppy enters the world, his first pack leader is his mother. Canine moms teach rules, boundaries, and limitations from day one!</p>
<p>Newborn puppies don't get a name like we do. The closest thing to a personality is a dog's status within the pack. In the animal world, there are two positions: the leader and the follower.</p>
<img class="ui disabled ignored image" src="/images/wireframe/short-paragraph.png">
</div>
@ -134,29 +138,28 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<h3 class="ui black block header">
Block Header
</h3>
<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>
<img class="ui disabled ignored image" src="/images/wireframe/media-paragraph.png">
</div>
<div class="example">
<h4 class="ui header">Attached</h4>
<p>A header can be attached to other content, like a <a href="/elements/segment.html">segment</a></p>
<h5 class="ui top attached header">
Bulldog
</h5>
<h3 class="ui top attached header">
Top Attached
</h3>
<div class="ui attached segment">
<p>Bulldog is the name for a breed of dog commonly referred to as the English Bulldog. Other Bulldog breeds include the American Bulldog, Old English Bulldog (now extinct), Olde English Bulldogge, and the French Bulldog. The Bulldog is a muscular, heavy dog with a wrinkled face and a distinctive pushed-in nose.</p>
<p>The American Kennel Club (AKC), The Kennel Club (UK), and the United Kennel Club (UKC) oversee breeding standards. Bulldogs are the 5th most popular purebreed in the United States in 2013 according to the American Kennel Club.</p>
<img class="ui disabled ignored image" src="/images/wireframe/paragraph.png">
</div>
<h5 class="ui attached header">
Catahoula Cur
</h5>
<h3 class="ui attached header">
Attached
</h3>
<div class="ui attached segment">
<p>The Catahoula Cur is an American dog breed named after Catahoula Parish, in the state of Louisiana, in the United States. After becoming the state dog of Louisiana in 1979, its name was officially changed to Louisiana Catahoula Leopard Dog. The Catahoula is believed to be the first dog breed developed in North America.</p>
<p>The breed is sometimes referred to as the "Catahoula Hound" or "Catahoula Leopard Hound", although it is not a true hound, but a cur. It is also called the "Catahoula Hog Dog", reflecting its traditional use in hunting wild boar.</p>
<img class="ui disabled ignored image" src="/images/wireframe/paragraph.png">
</div>
<h5 class="ui bottom attached header">
Thanks for reading
</h5>
<h3 class="ui bottom attached header">
Bottom Attached
</h3>
</div>
<div class="example">
@ -195,27 +198,21 @@ themes : ['Default', 'Classic', 'Bookish', 'Chubby']
<p>A header can be formatted with different colors</p>
<h3 class="ui black header">
Black
<div class="sub header">An excellent color</div>
</h3>
<h3 class="ui blue header">
Blue
<div class="sub header">An excellent color</div>
</h3>
<h3 class="ui red header">
Red
<div class="sub header">An excellent color</div>
</h3>
<h3 class="ui green header">
Green
<div class="sub header">An excellent color</div>
</h3>
<h3 class="ui purple header">
Purple
<div class="sub header">An excellent color</div>
</h3>
<h3 class="ui teal header">
Teal
<div class="sub header">An excellent color</div>
</h3>
</div>

140
server/documents/elements/image.html.eco

@ -20,15 +20,17 @@ themes : ['Default']
<div class="example">
<h4 class="ui header">Image</h4>
<p>An image</p>
<div class="ui ignored info message">Images will, by default, take up the same size as the original image. Specifying an image size will force an image to only take up a specific size.</div>
<img class="ui medium image" src="/images/demo/photo.jpg">
<div class="ui ignored info message">
Unless a size if specified, images will use the original dimensions of the image, with a maximum width of its container size <code>max-width: 100%</code>.
</div>
<img class="ui medium image" src="/images/wireframe/image.png">
</div>
<div class="example">
<h4 class="ui header">Image Link</h4>
<p>An image can be formatted to link to other content</p>
<a href="http://google.com" class="ui medium image">
<img src="/images/demo/photo.jpg">
<img src="/images/wireframe/image-text.png">
</a>
</div>
@ -39,7 +41,7 @@ themes : ['Default']
<div class="example">
<h4 class="ui header">Disabled</h4>
<p>An image can show that it is disabled and cannot be selected</p>
<img class="medium disabled ui image" src="/images/demo/photo.jpg">
<img class="medium disabled ui image" src="/images/wireframe/image.png">
</div>
<h2 class="ui dividing header">Variations</h2>
@ -47,60 +49,116 @@ themes : ['Default']
<div class="example">
<h4 class="ui header">Avatar</h4>
<p>An image may be formatted to appear inline with text as an avatar</p>
<img class="ui avatar image" src="/images/demo/photo2.jpg"> Dog Doggington
<img class="ui avatar image" src="/images/wireframe/square-image.png"> Username
</div>
<div class="example">
<h4 class="ui header">Bordered</h4>
<p>An image may include a border to emphasize the edges of white or transparent content</p>
<img class="ui medium bordered image" src="/images/wireframe/white-image.png">
</div>
<div class="example">
<h4 class="ui header">Rounded</h4>
<p>An image may appear rounded</p>
<img class="rounded ui image" src="/images/demo/photo2.jpg">
<img class="ui medium rounded image" src="/images/wireframe/square-image.png">
</div>
<div class="example">
<h4 class="ui header">Circular</h4>
<p>An image may appear circular</p>
<img class="circular ui image" src="/images/demo/photo2.jpg">
<img class="ui medium circular image" src="/images/wireframe/square-image.png">
</div>
<div class="example">
<h4 class="ui header">Vertically Aligned</h4>
<img class="ui top aligned tiny image" src="/images/demo/photo2.jpg"> Dog Doggington
<img class="ui top aligned tiny image" src="/images/wireframe/square-image.png"> Top Aligned
<br>
<img class="ui middle aligned tiny image" src="/images/demo/photo2.jpg"> Dog Doggington
<img class="ui middle aligned tiny image" src="/images/wireframe/square-image.png"> Middle Aligned
<br>
<img class="ui bottom aligned tiny image" src="/images/demo/photo2.jpg"> Dog Doggington
<img class="ui bottom aligned tiny image" src="/images/wireframe/square-image.png"> Bottom Aligned
</div>
<div class="example">
<h4 class="ui header">Floated</h4>
<p>An image can sit to the left or right of other content</p>
<div class="ui segment">
<img class="ui small left floated image" src="/images/demo/photo.jpg">
<p>Te eum doming eirmod, nominati pertinacia argumentum ad his. Ex eam alia facete scriptorem, est autem aliquip detraxit at. Usu ocurreret referrentur at, cu epicurei appellantur vix. Cum ea laoreet recteque electram, eos choro alterum definiebas in. Vim dolorum definiebas an. Mei ex natum rebum iisque.</p>
<img class="ui small right floated image" src="/images/demo/photo.jpg">
<p>Audiam quaerendum eu sea, pro omittam definiebas ex. Te est latine definitiones. Quot wisi nulla ex duo. Vis sint solet expetenda ne, his te phaedrum referrentur consectetuer. Id vix fabulas oporteat, ei quo vide phaedrum, vim vivendum maiestatis in.</p>
<img class="ui small left floated image" src="/images/wireframe/text-image.png">
<p>Te eum doming eirmod, nominati pertinacia argumentum ad his. Ex eam alia facete scriptorem, est autem aliquip detraxit at. Usu ocurreret referrentur at, cu epicurei appellantur vix. Cum ea laoreet recteque electram, eos choro alterum definiebas in. Vim dolorum definiebas an. Mei ex natum rebum iisque.</p>
<img class="ui small right floated image" src="/images/wireframe/text-image.png">
<p>Audiam quaerendum eu sea, pro omittam definiebas ex. Te est latine definitiones. Quot wisi nulla ex duo. Vis sint solet expetenda ne, his te phaedrum referrentur consectetuer. Id vix fabulas oporteat, ei quo vide phaedrum, vim vivendum maiestatis in.</p>
<p>Eu quo homero blandit intellegebat. Incorrupte consequuntur mei id. Mei ut facer dolores adolescens, no illum aperiri quo, usu odio brute at. Qui te porro electram, ea dico facete utroque quo. Populo quodsi te eam, wisi everti eos ex, eum elitr altera utamur at. Quodsi convenire mnesarchum eu per, quas minimum postulant per id.</p>
<p>Eu quo homero blandit intellegebat. Incorrupte consequuntur mei id. Mei ut facer dolores adolescens, no illum aperiri quo, usu odio brute at. Qui te porro electram, ea dico facete utroque quo. Populo quodsi te eam, wisi everti eos ex, eum elitr altera utamur at. Quodsi convenire mnesarchum eu per, quas minimum postulant per id.</p>
</div>
</div>
<div class="clearing example">
<h4 class="ui header">Sizes</h4>
<p>An image may be formatted to be different sizes</p>
<img class="ui mini image" src="/images/demo/highres3.jpg">
<div class="ui ignored divider"></div>
<img class="ui tiny image" src="/images/demo/highres3.jpg">
<div class="ui ignored divider"></div>
<img class="ui small image" src="/images/demo/highres3.jpg">
<div class="ui ignored divider"></div>
<img class="ui medium image" src="/images/demo/highres3.jpg">
<div class="ui ignored divider"></div>
<img class="ui large image" src="/images/demo/highres3.jpg">
<div class="ui ignored divider"></div>
<img class="ui big image" src="/images/demo/highres3.jpg">
<div class="ui ignored divider"></div>
<img class="ui huge image" src="/images/demo/highres3.jpg">
<div class="ui ignored divider"></div>
<img class="ui massive image" src="/images/demo/highres3.jpg">
<p>An image may appear at different sizes</p>
<div class="ui ignored info message">
Semantic uses arbitrary default values for image sizes from mini to massive. It is recommended to update these with values used in your project in <code>image.variables</code>.
</div>
<table class="ui definition table">
<thead>
<tr>
<th>Class Name</th>
<th>Size</th>
</tr>
</thead>
<tbody>
<tr>
<td>Mini</td>
<td>20px</td>
</tr>
<tr>
<td>Tiny</td>
<td>80px</td>
</tr>
<tr>
<td>Small</td>
<td>150px</td>
</tr>
<tr>
<td>Medium</td>
<td>300px</td>
</tr>
<tr>
<td>Large</td>
<td>450px</td>
</tr>
<tr>
<td>Big</td>
<td>600px</td>
</tr>
<tr>
<td>Huge</td>
<td>800px</td>
</tr>
<tr>
<td>Massive</td>
<td>960px</td>
</tr>
</tbody>
</table>
<img class="ui mini image" src="/images/wireframe/image.png">
<div class="ui hidden divider"></div>
<img class="ui tiny image" src="/images/wireframe/image.png">
<div class="ui hidden divider"></div>
<img class="ui small image" src="/images/wireframe/image.png">
<div class="ui hidden divider"></div>
<img class="ui medium image" src="/images/wireframe/image.png">
<div class="existing code">
<img class="ui mini image" src="/images/wireframe/image.png">
<img class="ui tiny image" src="/images/wireframe/image.png">
<img class="ui small image" src="/images/wireframe/image.png">
<img class="ui medium image" src="/images/wireframe/image.png">
<img class="ui large image" src="/images/wireframe/image.png">
<img class="ui big image" src="/images/wireframe/image.png">
<img class="ui huge image" src="/images/wireframe/image.png">
<img class="ui massive image" src="/images/wireframe/image.png">
</div>
</div>
@ -110,19 +168,19 @@ themes : ['Default']
<div class="example">
<h4 class="ui header">Sizes</h4>
<p>A group of images can be formatted to have the same size.</p>
<div class="ui small images">
<img class="ui image" src="/images/demo/photo.jpg">
<img class="ui image" src="/images/demo/photo.jpg">
<img class="ui image" src="/images/demo/photo.jpg">
<img class="ui image" src="/images/demo/photo.jpg">
<div class="ui tiny images">
<img class="ui image" src="/images/wireframe/image.png">
<img class="ui image" src="/images/wireframe/image.png">
<img class="ui image" src="/images/wireframe/image.png">
<img class="ui image" src="/images/wireframe/image.png">
</div>
</div>
<div class="another example">
<div class="ui medium images">
<img src="/images/demo/photo.jpg">
<img src="/images/demo/photo.jpg">
<img src="/images/demo/photo.jpg">
<img src="/images/demo/photo.jpg">
<div class="ui small images">
<img src="/images/wireframe/image.png">
<img src="/images/wireframe/image.png">
<img src="/images/wireframe/image.png">
<img src="/images/wireframe/image.png">
</div>
</div>

server/files/images/animals/2033_m3.jpg → server/files/images/animals/moose-love.jpg

server/files/images/animals/2032_m3.jpg → server/files/images/animals/moose.jpg

server/files/images/animals/2045_m3.jpg → server/files/images/animals/poney.jpg

BIN
server/files/images/leaves/10.png

Before After
Width: 687  |  Height: 828  |  Size: 250 KiB Width: 828  |  Height: 687  |  Size: 279 KiB

BIN
server/files/images/wireframe/centered-paragraph.png

Before After
Width: 800  |  Height: 162  |  Size: 1.9 KiB

BIN
server/files/images/wireframe/image-square.png

Before After
Width: 796  |  Height: 796  |  Size: 6.1 KiB

BIN
server/files/images/wireframe/image-text.png

Before After
Width: 960  |  Height: 797  |  Size: 9.6 KiB

BIN
server/files/images/wireframe/image.png

Before After
Width: 960  |  Height: 796  |  Size: 7.0 KiB

BIN
server/files/images/wireframe/media-paragraph-alt.png

Before After
Width: 600  |  Height: 117  |  Size: 2.3 KiB

BIN
server/files/images/wireframe/media-paragraph.png

Before After
Width: 600  |  Height: 140  |  Size: 3.4 KiB

BIN
server/files/images/wireframe/paragraph.png

Before After
Width: 625  |  Height: 213  |  Size: 2.4 KiB

BIN
server/files/images/wireframe/short-paragraph.png

Before After
Width: 625  |  Height: 66  |  Size: 1.3 KiB

BIN
server/files/images/wireframe/square-image.png

Before After
Width: 259  |  Height: 259  |  Size: 1.7 KiB

BIN
server/files/images/wireframe/text-image.png

Before After
Width: 317  |  Height: 262  |  Size: 1.9 KiB

BIN
server/files/images/wireframe/white-image.png

Before After
Width: 796  |  Height: 796  |  Size: 5.8 KiB

2
server/files/javascript/semantic.js

@ -223,7 +223,7 @@ semantic.ready = function() {
},
tryCreateMenu: function(event) {
if($(window).width() > 1000) {
if($(window).width() > 640) {
if($container.find('.following.menu').size() === 0) {
handler.createMenu();
handler.createWaypoints();

7
server/files/stylesheets/semantic.css

@ -1091,6 +1091,13 @@ body.progress.animated .ui.progress .bar {
height: 165px;
vertical-align: middle;
}
/*--------------
Header
---------------*/
#example.header .sizer {
padding: 1rem 0em;
}
/*--------------
Flag

2
server/layouts/default.html.eco

@ -185,7 +185,7 @@
<a class="ui logo icon image" href="/">
<img src="/images/logo.png">
</a>
UI Docs
<a href="/"><b>UI Docs</b></a>
</div>
<a class="item" href="/build/semantic.zip">
<i class="download icon"></i> <b>Download</b>

Loading…
Cancel
Save