CAZypedia needs your help!
We have many unassigned pages in need of Authors and Responsible Curators. See a page that's out-of-date and just needs a touch-up? - You are also welcome to become a CAZypedian. Here's how.
Scientists at all career stages, including students, are welcome to contribute.
Learn more about CAZypedia's misson here and in this article.
Totally new to the CAZy classification? Read this first.

Difference between revisions of "Help:Images"

From CAZypedia
Jump to navigation Jump to search
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
This page describes how to add an image to a page to maintain a constant "look and feel" across ''CAZypedia''.
 +
 
''CAZypedia'' generally contains two types of image placements in pages:
 
''CAZypedia'' generally contains two types of image placements in pages:
 
* Simple pictures without borders or frames, as found on ''CAZypedia'' [[:Category:Contributors|Contributor pages]], and
 
* Simple pictures without borders or frames, as found on ''CAZypedia'' [[:Category:Contributors|Contributor pages]], and
 
* Figures with legends, as found on various content pages, e.g. [[Glycoside Hydrolase Families|GH Family pages]].
 
* Figures with legends, as found on various content pages, e.g. [[Glycoside Hydrolase Families|GH Family pages]].
  
This page describes how to add an image to a page to maintain a constant "look and feel" across ''CAZypedia''.
+
Two independent steps are required, which are detailed below:
 +
# Uploading an image to the wiki.
 +
# Adding some wiki code in a page to place the image.
 +
 
  
 
== Uploading an image ==
 
== Uploading an image ==
Line 14: Line 19:
 
# '''Make a note of your uploaded image's filename, as you will need this exact name to add the image to a page.'''
 
# '''Make a note of your uploaded image's filename, as you will need this exact name to add the image to a page.'''
  
''Note: If you forget the filename, uploaded files can be found via one of these two pages:''
+
<blockquote class="toccolours" style="float:none; padding: 10px 15px 10px 15px;  display:table;">
* [[Special:ListFiles|File list]]
+
''Notes:''
* [[Special:NewFiles|Gallery of new files]]
+
* If you forget the filename, uploaded files can be found via one of these two pages:''
 +
** [[Special:ListFiles|File list]]
 +
** [[Special:NewFiles|Gallery of new files]]
 +
* Images can easily be rescaled in ''CAZypedia'' itself (see below), so it is not necessary to produce images to an exact size.  However, it is good to have originals no more than 2x larger than the desired size on the page.
 +
* PNG format is slightly preferred to JPEG in most cases.
 +
</blockquote>
  
 
== Adding an image to a page ==
 
== Adding an image to a page ==
 
=== Contributor (User) pages ===
 
=== Contributor (User) pages ===
[[Image:JH.jpg|200px|right]]
+
[[File:JH.jpg|200px|right]]
To insert a simple image without a frame nor border, as in the example to the right:
+
User pages contain pictures of people [[:Category:Contributors|''CAZypedia'' Contributors]] without frames, borders, or other embellishments.  To insert such an image, as in the example to the right:
# Copy and paste this code to your page:
+
# Copy and paste this wiki code to your page: <code><nowiki>[[File:filename.png|200px|right]]</nowiki></code>
* code
 
 
# Change "filename.png" to the filename of the image you wish to include.
 
# Change "filename.png" to the filename of the image you wish to include.
 +
 +
<blockquote class="toccolours" style="float:none; padding: 10px 15px 10px 15px;  display:table;">
 +
''Notes:''
 +
* In general, the wiki code should be placed ''as the first item in the page.''
 +
* "200px" specifies the image width in pixels.  This is ''CAZypedia's'' standard width for [[:Category:Contributors|Contributor pictures]]. Only in exceptional cases should this be altered.
 +
* "right" places the image on the right side of the page. Again, this a ''CAZypedia'' standard.
 +
</blockquote>
  
 
=== Content pages ===
 
=== Content pages ===
 +
Content pages contain figures with borders and legends.  To insert such an image:
 +
# Copy and paste this wiki code to your page: <code><nowiki>[[File:filename.png|thumb|300px|right|'''Figure X.''' Figure legend.]]</nowiki></code>
 +
# Change "filename.png" to the filename of the image you wish to include.
 +
# Change or delete the figure number and adjust the figure legend.
 +
 +
[[File:Overall Structure.png|thumb|right|300px|'''Figure 1. Cartoon structure and transparent surface representation of "GH61A" from ''Thermoascus aurantiacus'' (PDB ID [{{PDBlink}}2yet 2YET] <cite>Quinlan2011</cite>).''' A bound copper atom at the active site is shown as a sphere on the top flat surface where substrate very likely binds. To the right is a view of the active site showing the axially elongated tetragonal coordination geometry of the Cu(II) ion. The "histidine brace" is comprised of the N-terminal amine and imidazole of the very highly conserved N-terminal methyl-histidine along with the imidazole of a second highhly conserved histidine. The fourth equatorial position is occupied by a water molecule H-bonded to a highly conserved glutamine that is important for function <cite>Harris2010</cite>. A somewhat distant phenolic oxygen of a very highly conserved tyrosine occupies one of the axial positions, and an additional water molecule occupies the other. In other AA9 structures the axial water position is either vacant or occupied by what appears to be a superoxide or peroxide and may thus be the site of oxygen binding <cite>Li2012</cite>.]]
 +
<blockquote class="toccolours" style="float:none; padding: 10px 15px 10px 15px;  display:table;">
 +
''Notes:''
 +
* In general, the wiki code should be placed ''immediately before the first paragraph'' of the corresponding section in the text. ''You may look at the wiki code of this page for examples.''
 +
* "thumb" specifies that the image should be rendered as a thumbnail,
 +
* "300px" specifies the image width in pixels.  Depending upon the image, a value in the range 300-500 is usually suitable.  In general, it is best to keep figures less than 1/3 of a page wide at normal screen resolutions.
 +
* "right" places the image on the right side of the page. This a ''CAZypedia'' standard.
 +
* Figure legends can be very sophisticated, including links to internal and external pages, as well as references, as shown in the example of Figure 1 on the right. ''You may open this Help page for editing to view and/or copy the wiki code used for this example, which comes from the [[AA9]] page.''
 +
</blockquote>
 +
 +
<br clear=all>
 +
 +
=== Problems with image placement ===
 +
The above instructions should be sufficient to properly place images in pages most of the time.  However, unexpected layout effects can occur from time to time, due to the dynamic way ''CAZypedia'' pages are rendered.  '''It is best to consult with the [[Board of Curators|Senior Curator]] before investing too much time trying to correct a specific image layout problem.'''  If you are feeling adventurous, see the [[#Additional image help]] section below.
 +
 +
==== Stopping text flow around an image ====
 +
Following the guidelines above, images will be stacked along the right side of the ''CAZypedia'' page, with text flowing around the left side.  It is sometimes useful to break this automatic text flow, especially when beginning a new page section.  An example of this occurs in the case of the ''Problems with image placement'' section on this page (notice the large amount of white space next to the image before this section).
 +
 +
To break the text flow and restart it after an image, insert the following wiki code just before a paragraph or section heading:
 +
* <code><nowiki><br clear=all></nowiki></code>
 +
 +
''You may look at the wiki code of this page to see how this is used in practice.''
 +
 +
=== Additional image help ===
 +
Additional help, including extra image options, can be found on these pages:
 +
* https://www.mediawiki.org/wiki/Help:Images
 +
* http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax
 +
 +
 +
 +
----
 +
''(Figure 1 example references.)''
 +
<biblio>
 +
#Harris2010 pmid=20230050
 +
#Quinlan2011 pmid=21876164
 +
#Li2012 pmid=22578542
 +
</biblio>

Latest revision as of 10:13, 6 August 2020

This page describes how to add an image to a page to maintain a constant "look and feel" across CAZypedia.

CAZypedia generally contains two types of image placements in pages:

  • Simple pictures without borders or frames, as found on CAZypedia Contributor pages, and
  • Figures with legends, as found on various content pages, e.g. GH Family pages.

Two independent steps are required, which are detailed below:

  1. Uploading an image to the wiki.
  2. Adding some wiki code in a page to place the image.


Uploading an image

The first step in adding an image to a CAZypedia page is to upload that image to the wiki. This is done through the Special:Upload page, which can be accessed from any CAZypedia page via the "Upload file" link in the "Toolbox" section of the left menu.

  1. Go to the Special:Upload page.
  2. Click the "Browse" button to locate the image file on your computer.
  3. Change the "Destination filename" to something sensible, if it is not already.
  4. Adding a summary can be helpful (image source, content, author, etc. Do not upload copyrighted material without permission.).
  5. Click the "Upload file" button at the bottom of the page.
  6. Make a note of your uploaded image's filename, as you will need this exact name to add the image to a page.

Notes:

  • If you forget the filename, uploaded files can be found via one of these two pages:
  • Images can easily be rescaled in CAZypedia itself (see below), so it is not necessary to produce images to an exact size. However, it is good to have originals no more than 2x larger than the desired size on the page.
  • PNG format is slightly preferred to JPEG in most cases.

Adding an image to a page

Contributor (User) pages

JH.jpg

User pages contain pictures of people CAZypedia Contributors without frames, borders, or other embellishments. To insert such an image, as in the example to the right:

  1. Copy and paste this wiki code to your page: [[File:filename.png|200px|right]]
  2. Change "filename.png" to the filename of the image you wish to include.

Notes:

  • In general, the wiki code should be placed as the first item in the page.
  • "200px" specifies the image width in pixels. This is CAZypedia's standard width for Contributor pictures. Only in exceptional cases should this be altered.
  • "right" places the image on the right side of the page. Again, this a CAZypedia standard.

Content pages

Content pages contain figures with borders and legends. To insert such an image:

  1. Copy and paste this wiki code to your page: [[File:filename.png|thumb|300px|right|'''Figure X.''' Figure legend.]]
  2. Change "filename.png" to the filename of the image you wish to include.
  3. Change or delete the figure number and adjust the figure legend.
Figure 1. Cartoon structure and transparent surface representation of "GH61A" from Thermoascus aurantiacus (PDB ID 2YET [1]). A bound copper atom at the active site is shown as a sphere on the top flat surface where substrate very likely binds. To the right is a view of the active site showing the axially elongated tetragonal coordination geometry of the Cu(II) ion. The "histidine brace" is comprised of the N-terminal amine and imidazole of the very highly conserved N-terminal methyl-histidine along with the imidazole of a second highhly conserved histidine. The fourth equatorial position is occupied by a water molecule H-bonded to a highly conserved glutamine that is important for function [2]. A somewhat distant phenolic oxygen of a very highly conserved tyrosine occupies one of the axial positions, and an additional water molecule occupies the other. In other AA9 structures the axial water position is either vacant or occupied by what appears to be a superoxide or peroxide and may thus be the site of oxygen binding [3].

Notes:

  • In general, the wiki code should be placed immediately before the first paragraph of the corresponding section in the text. You may look at the wiki code of this page for examples.
  • "thumb" specifies that the image should be rendered as a thumbnail,
  • "300px" specifies the image width in pixels. Depending upon the image, a value in the range 300-500 is usually suitable. In general, it is best to keep figures less than 1/3 of a page wide at normal screen resolutions.
  • "right" places the image on the right side of the page. This a CAZypedia standard.
  • Figure legends can be very sophisticated, including links to internal and external pages, as well as references, as shown in the example of Figure 1 on the right. You may open this Help page for editing to view and/or copy the wiki code used for this example, which comes from the AA9 page.


Problems with image placement

The above instructions should be sufficient to properly place images in pages most of the time. However, unexpected layout effects can occur from time to time, due to the dynamic way CAZypedia pages are rendered. It is best to consult with the Senior Curator before investing too much time trying to correct a specific image layout problem. If you are feeling adventurous, see the #Additional image help section below.

Stopping text flow around an image

Following the guidelines above, images will be stacked along the right side of the CAZypedia page, with text flowing around the left side. It is sometimes useful to break this automatic text flow, especially when beginning a new page section. An example of this occurs in the case of the Problems with image placement section on this page (notice the large amount of white space next to the image before this section).

To break the text flow and restart it after an image, insert the following wiki code just before a paragraph or section heading:

  • <br clear=all>

You may look at the wiki code of this page to see how this is used in practice.

Additional image help

Additional help, including extra image options, can be found on these pages:



(Figure 1 example references.)

  1. Quinlan RJ, Sweeney MD, Lo Leggio L, Otten H, Poulsen JC, Johansen KS, Krogh KB, Jørgensen CI, Tovborg M, Anthonsen A, Tryfona T, Walter CP, Dupree P, Xu F, Davies GJ, and Walton PH. (2011). Insights into the oxidative degradation of cellulose by a copper metalloenzyme that exploits biomass components. Proc Natl Acad Sci U S A. 2011;108(37):15079-84. DOI:10.1073/pnas.1105776108 | PubMed ID:21876164 [Quinlan2011]
  2. Harris PV, Welner D, McFarland KC, Re E, Navarro Poulsen JC, Brown K, Salbo R, Ding H, Vlasenko E, Merino S, Xu F, Cherry J, Larsen S, and Lo Leggio L. (2010). Stimulation of lignocellulosic biomass hydrolysis by proteins of glycoside hydrolase family 61: structure and function of a large, enigmatic family. Biochemistry. 2010;49(15):3305-16. DOI:10.1021/bi100009p | PubMed ID:20230050 [Harris2010]
  3. Li X, Beeson WT 4th, Phillips CM, Marletta MA, and Cate JH. (2012). Structural basis for substrate targeting and catalysis by fungal polysaccharide monooxygenases. Structure. 2012;20(6):1051-61. DOI:10.1016/j.str.2012.04.002 | PubMed ID:22578542 [Li2012]

All Medline abstracts: PubMed