OpenEI:Tutorials outline

From Open Energy Information

This is a outline document for content and scripted material for video tutorials for the OpenEI site. Order is listed by priority.

OpenEI Overview

" overview of what OpenEI offers. It would be great to see a similar video showing brief summaries of all the different data types OpenEI has to offer and how a borad audience might be able to use this data."

OpenEI/Navigation Overview

  • Overview

Hi, my name is ____ and I'm here to today to talk about OpenEI. Open Energy Info (or OpenEI for short) is a platform to connect the world’s energy data. It is a linked open data platform bringing together energy information to provide improved analyses, unique visualizations, and real-time access to data.

As part of the White House’s Open Government Initiative, we are focused on transparency, collaboration, and participation.

The goal is to provide open access to this energy information, to spur creativity and drive innovation in the energy sector.

  • Navigating - Gateways

The site is organized into some high-level subject areas to focus on particular projects currently underway. We call these gateways. You can access these gateway pages from [show main page gateway nav icons] the navigation icons on the main page or [show drop-down Browse menu] via the Browse menu on any page on the site. These gateway pages bring together information on the site in one place to give you easier access to the information you are looking for. [navigate to U.S. OpenLabs] For instance, the U.S. OpenLabs gateway was recently developed to highlight U.S. national labs programs and tools that promote clean energy development around the world. As OpenEI grows, expect to see more gateway pages develop.

  • Editing

[navigate to [[Afghanistan Resource Maps and Toolkits]] by zooming in on Clean Energy Initiatives map and clicking pin.]

OpenEI is based on the same MediaWiki software that runs the world's largest online reference, Wikipedia. Any page can be changed or edited simply by clicking on the "Edit" tab. Many of the sites pages are based on pre-structured forms. In those case, simply select "Edit with form". [open edit form for Afghanistan Resources Maps and Toolkits page] Here you can make changes to the form. The main article content uses a syntax called wikitext. You can learn more about wikitext by checking out [show help link in menu] the online help available in the navigation menu.

[cancel and navigate back to main page]

You can also add new pages by choosing [click on]"Contribute" and "Add a new page" from the navigation menu. This will show a selection of all the forms available on the site.

At any time, simply [click on]click on the OpenEI image in the top banner to return to the main page.

  • Navigating - Search

To search, you simply type in the ‘search’ text box. [type NRE... in search. select NREL and type return] As you type, suggestions will appear to existing pages on the wiki. If there is an exact match for your search terms, you will be brought directly to that page. Otherwise, you will be directed to the search results and can choose from these.

  • Share

[click Share menu]

Any page can be shared with others by clicking on "Share". You can post about the page on Twitter, LinkedIn, or Facebook. Or you can simply email the page to someone.

  • Closing


  • Show a form example of a company with info already filled in

"Hi, my name is ____ and I'm going to show you how to provide a reference when contributing content to OpenEI. Providing proper citations when contributing to OpenEI is an important part of the sites core content principles."

  • OpenEI Core Content Policies

"It is important, when contributing, to follow the OpenEI:Core content policies. First, you must take a neutral point of view when contributing. Second, any content added by you from another source must reference that source, giving it verifiability. Third, OpenEI accepts no original research. Information should come from a secondary, verifiable source."

"Here is an example of a company form already completed."

  • New Page

"There is an 'edit' and 'edit with form' option on every page in the website. This is for editing the main pages. If you know exactly where you'd like to contribute, simply click on the gateway and find the +add button next to the category you wish to contribute to. "

  • Existing Page

"If you'd like to add to an existing page, bring up that page and click either 'edit' or 'edit with form'."

  • Open ‘edit with form’

"To reference your page, go to the ‘edit with form’ tab…"

  • Scroll to ‘reference’, under map

FIXME:I think we should flip-flop these and highlight the "easy reference" here. I've updated the NREL page so that it will display the easy reference instead. Also, my idea here was that you could show a browser window with NREL website up. Show copying the about url and pasting into the reference, etc.

"In this case, we are going to scroll to the reference area under the map on the National Renewable Energy Laboratory page. You will see the syntax used to put in references on the wiki. The name About NREL will show up in the form, the [1] at the end of the text are needed to surround the URL. Inside the [ ], you place the URL, making sure it contains http://. If you'd like to add another name after URL, this will make the reference show up under the text in the text box."

  • Easy reference field

"To avoid all of this, you can toggle the advanced syntax by unchecking the box. This will bring up an easy-to-follow form for adding references."

  • Input fields, with brief explanation (explain “add another”, “update”, “delete”)
  • Title

"The title should be the title of the company, organization, lab, etc. that you are inputting [Show a correct title]."

  • URL

"To add a company URL, place it in the Website field of the form. Make sure the URL is preceded with http://."

“Simply input the fields. If you wish to add another source, just click ‘add another’”

  • Preview

“Click the ‘preview’ button. Your changes are not saved yet, but you can view what the page will look like.”

The Reference Tag

“If you are referencing within the text, either by paraphrasing or direct quotations, you will need to add a ‘reference tag’, either directly after a quote or at the end of a paragraph of paraphrased text. The ‘name’ field in the reference area is how you will reference within text. You will need to use the syntax ‘<ref name=”name of reference” />. This will allow the reference to show up in the text, and also be accounted for in the reference section at the bottom of the text area. Once finished, make sure to save and you have just properly referenced an openei wiki page. Thanks for you contributions and keep them coming!”


  • Show entry using different quotation examples (Block, single sentence), etc..

“Here is an example of a block quote, when a quote is longer than one-two sentences...”

“Here is an example of a short quote, which can exist within the text...”

“Here is an example of text that is paraphrased, and cited at the end of the paragraph...”

  • Explain Wiki standards on quotations

“(from the wiki) : A quote longer than four lines should be written as a block quotation. Do not put the block quote in quotation marks. To do a block quotation, do not use the wiki indentation mark : – instead, use the HTML <blockquote> tag: “Here are the wiki manual of style and quotation requirements found at [1]

  • Enter in Wiki
  • Use ‘ref tag’ properly for each quotation type

“Using the name you chose in the ‘reference’ field, simply put the syntax <ref name=”name” /> at the end of the quote, or paragraph.”

  • Preview, then save

“Preview to see if you need to make any edits, then be sure to save and you have just created an openei page. Thank you for your contributions and keep them coming.”


“To register, start at Click on the blue link labeled ‘sign up’, in the upper right hand corner."

FIXME:please feel free to edit

"To register you will need to provide a user name. This is how you will be identified to other wiki users. Enter a secure password. FIXME:need details here on what are password requirements, e.g. length, characters, etc. Enter your email address. This is needed so you can send and receive messages from other wiki users. You can control your email preferences under your user preferences after you are referenced. Your email address is secure and will never be exposed to other users. Then put in your name. This way we can give you credit for your contributions to the wiki. Complete the captcha to prove you are a human user. The captcha prevents fraudulent user registrations that can cause spam. And finally, you must agree to the user agreement when you register. This agreement states that all your contributions will be released into the public domain and that you have the authority to release the information. We at OpenEI believe in openness and this agreement simply states that you agree with this level of openness."

"Once you are registered, you will now be able to contribute to the wiki. If you do not wish to register, you will still be able to view content, but will not be allowed to contribute any information.”

Uploading Images

  • Show a form example of a company with info filled in

“I am going to show you how to upload a logo onto the wiki. Here is a form already filled in.”

  • Explain Wiki standards on using images from the internet (must come from company page, or be sourced online)

“The wiki requires that you be able to cite an online source where the image originated, preferably to a company’s page.”

  • Download the image, and add image to the field

“After downloading the image, click on the ‘upload file’ link, browse to find your file, and click ‘upload. You can preview to see your logo on the top of the form on the right of the screen. Make sure to save once done.”

  • Show how to load an image into the text, by using ex: ‘[[File:solartwo.jpg|left|Solar Two in the Mojave Desert]]’ syntax

"If you would like to put an image into the text you will need to input the syntax ‘[[File:solartwo.jpg|left|Solar Two in the Mojave Desert, similar to what Ivanpah will look like]]’ at the top of a paragraph of text. Once the text is in the ‘article text’ field, save. Then, click the ‘red link’ and you will be taken to a screen where you can upload your image, similar to the logo field. Click ‘upload’ and save all final changes. You can play with the justification right or left, and the size by adjusting the ‘px’."

FIXME:Direct to Help:Images for more details.

  • Preview, then save

“Preview your picture to make sure you like it, then save and you have just uploaded an image to the openei wiki. Thanks for your contributions, and keep them coming!”

Company Info/Editing Basics

  • Show a company page, with corresponding info
  • Mention the main important info: what, where, employee #, year founded

“Here is an example of a good wiki entry. This page’s text tells you what the company is, where it is located, what products/services it offers. If you can also include the # of employees and the year it was founded, this is also very beneficial.”

  • Explain Wiki standards on sourcing from company website

“Typical wiki entries have the company name first in the text and in bold. To do this, simply add 3 ‘’’ before and after the word. Also, the location, in order to create a link to this location should look something like this [[Chicago, Illinois]]. When saved, this will then become a link, and you can click it and follow it to information found in Chicago, Illinois."

  • Preview, then save

“Good practice is to preview your work before you save it. If you do save it and later rediscover a problem, you can still go back and ‘edit’ or ‘edit with form’. Once all edits are made, make sure you do a final ‘save’ and you have now contributed to the wiki. Again, thanks for the contribution and keep it coming!!”

Semantic Features (future)

  • Browse properties
  • Categories
  • after the name and the