Editing GO Site (Retired): Difference between revisions

From GO Wiki
Jump to navigation Jump to search
No edit summary
(Undo revision 46828 by Sjcarbon (talk))
Line 13: Line 13:
* Editors (you) have broad powers in editing and creating content, however and limited in deleting content; if you need something deleted, please contact a Manager (currently Chris or Seth)
* Editors (you) have broad powers in editing and creating content, however and limited in deleting content; if you need something deleted, please contact a Manager (currently Chris or Seth)
* To view a book as a single page, click on the "Printer-friendly version" link
* To view a book as a single page, click on the "Printer-friendly version" link
* {{Drupal:twitter_push}}
* Save your work. '''Remember to always save your work.'''


= How to add content =
= How to add content =
Line 30: Line 30:
# Begin typing text using HTML tags as allowed in the list of 'Almost HTML', located under the editing box. You may use your editor of choice to prepare the HMTL elsewhere and paste it on the box. Alternatively, directly copy and paste the text from the raw HTML found in the corresponding file from the list of old site documents. If you choose to follow the latter method, please be aware that you need to further edit the text to remove unnecessary titles, and in many cases to introduce breaks. Please compare with the 'old' site for accuracy of content and sequence.  
# Begin typing text using HTML tags as allowed in the list of 'Almost HTML', located under the editing box. You may use your editor of choice to prepare the HMTL elsewhere and paste it on the box. Alternatively, directly copy and paste the text from the raw HTML found in the corresponding file from the list of old site documents. If you choose to follow the latter method, please be aware that you need to further edit the text to remove unnecessary titles, and in many cases to introduce breaks. Please compare with the 'old' site for accuracy of content and sequence.  
# If you wish control the text that appears in teasers or content lists, you may edit what appears by opening the '''Edit summary''' link.
# If you wish control the text that appears in teasers or content lists, you may edit what appears by opening the '''Edit summary''' link.
# Preview your work using the button at the bottom of the page.
# Preview your work using the button at the bottom of the page.  
# {{Drupal:twitter_push}}
# Save your work. '''Remember to always save your work'''.


=== Book pages ===
=== Book pages ===
Line 44: Line 44:
# To populate additional pages for the book you just created, click on the '''Add child page''' link at the bottom of the page, and follow directions in steps 2-8 from the section on '''How to add content''' for '''Pages'''.
# To populate additional pages for the book you just created, click on the '''Add child page''' link at the bottom of the page, and follow directions in steps 2-8 from the section on '''How to add content''' for '''Pages'''.
# Before exiting the '''Edit''' view, check the section on '''Book outline''' at the bottom of the page. Corroborate that the '''Book''' and '''Parent item''' menus are correct.
# Before exiting the '''Edit''' view, check the section on '''Book outline''' at the bottom of the page. Corroborate that the '''Book''' and '''Parent item''' menus are correct.
# {{Drupal:twitter_push}}
# Save your work. '''Remember to always save your work'''.


=== Articles ===
=== Articles ===
Line 51: Line 51:


# TODO
# TODO
# {{Drupal:twitter_push}}
# Save your work. '''Remember to always save your work'''.


{{Drupal:twitter_push}}
{{Drupal:twitter_push}}
Line 60: Line 60:


# TODO
# TODO
# {{Drupal:always_save}}
# Save your work. '''Remember to always save your work'''.


=== Highlighted terms ===
=== Highlighted terms ===
Line 67: Line 67:


# TODO
# TODO
# {{Drupal:always_save}}
# Save your work. '''Remember to always save your work'''.


{{Drupal:twitter_push}}
{{Drupal:twitter_push}}
Line 81: Line 81:
# Click on the '''Revisions''' tab
# Click on the '''Revisions''' tab
# Make your desired changes, just as if you were creating the content
# Make your desired changes, just as if you were creating the content
# {{Drupal:twitter_push}}
# Save your work. '''Remember to always save your work'''


== Books ==
== Books ==
Line 92: Line 92:
# Select the '''edit order and title''' link for the book that you wanted to edit
# Select the '''edit order and title''' link for the book that you wanted to edit
# On this page you may change order and nesting by dragging and dropping items; you may also rename the individual "chapter" titles
# On this page you may change order and nesting by dragging and dropping items; you may also rename the individual "chapter" titles
# {{Drupal:twitter_push}}
# Save your work. '''Remember to always save your work.'''


== Versions and reversions ==
== Versions and reversions ==
Line 103: Line 103:
# View the revisions by clicking on the links under Revision
# View the revisions by clicking on the links under Revision
# Revert by clicking the '''revert''' link under Operations
# Revert by clicking the '''revert''' link under Operations
# {{Drupal:twitter_push}}


= Style guide =
= Style guide =

Revision as of 17:20, 30 October 2013

Warning: Please make sure that you have read the most recent version of this document before contacting Seth or Moni.


General notes

  • The URL for the text versions of the pages scraped from the old website is: http://nakama.berkeleybop.org/go
  • The spreadsheet listing pages and assignments for content migration is located at http://goo.gl/Bcr1VC
  • The user login page is at: http://beta.geneontology.org/user/login ; this may change in the future--if this link does not work, check back here
  • All internal links should be relative. Examples below.
    • To link to the book containing the GO evidence code guide, you may type the following:
      Refer to the <a href="/book/guide-go-evidence-codes">GO evidence code guide</a> for the list of valid evidence codes.
    • On the other hand, to link to a page such as the 'Tools' tab, type:
      More information is available on the <a href="/page/tools">Tools Page</a>.
  • Editors cannot currently change menus, if you need a menu change please contact a Manager (currently Chris or Seth)
  • Editors (you) have broad powers in editing and creating content, however and limited in deleting content; if you need something deleted, please contact a Manager (currently Chris or Seth)
  • To view a book as a single page, click on the "Printer-friendly version" link
  • Save your work. Remember to always save your work.

How to add content

All content on a Drupal website is stored and treated as "nodes". A node is any posting, such as a page, book, or an article. Treating all content as nodes allows the flexibility of creating new types of content, and allows new features or changes to roll to all content.

After login there will be a menu visible in the left column. It contains links to add new content, currently: article, page, book, highlighted term, and external project. There is also a link to list all available current content at find content.

Info pages

  1. Click Add page from navigation.
  2. Enter a Title for the page. It will be displayed at the top. Please 'Capitalize Each Word' for the tile sentence. Keep in mind that the title will also form the final URL.
  3. Carefully choose the intended audience from the User Story menu. You may have multiple user stories.
  4. Choose the appropriate Tags to categorize this content. Is this page a guide document? Or is it describing the structure of the ontology? You may have multiple tags.
  5. From the content window, choose to either work using 'Source' code, using the button on the upper left corner of the box, or choose to 'Switch to plain text editor' from the options underneath the box. The difference will be obvious, and you will choose the one that is more familiar/comfortable to you. The editing box can be resized from the bottom right corner.
  6. Begin typing text using HTML tags as allowed in the list of 'Almost HTML', located under the editing box. You may use your editor of choice to prepare the HMTL elsewhere and paste it on the box. Alternatively, directly copy and paste the text from the raw HTML found in the corresponding file from the list of old site documents. If you choose to follow the latter method, please be aware that you need to further edit the text to remove unnecessary titles, and in many cases to introduce breaks. Please compare with the 'old' site for accuracy of content and sequence.
  7. If you wish control the text that appears in teasers or content lists, you may edit what appears by opening the Edit summary link.
  8. Preview your work using the button at the bottom of the page.
  9. Save your work. Remember to always save your work.

Book pages

A book is a set of nodes tied together in a hierarchy, perhaps with chapters, sections, subsections, and so on. We can use books for manuals, site resource guides, Frequently Asked Questions (FAQs), etc. It can be thought of as a shadow taxonomy for pages.

  1. Click Add book from navigation.
  2. Enter a Title for the book. It will be displayed at the top. Please 'Capitalize Each Word' for the tile sentence. Keep in mind that the title will also form the final URL.
  3. Carefully choose the intended audience from the User Story menu. You may have multiple user stories. You will not be prompted to enter Tags for this content.
  4. Follow directions in steps 5-7 on editing 'Pages'. The content you just prepared will be the 'front page' of the book.
  5. Preview your work using the button at the bottom of the page. At this point save the page, so it becomes the first page of the book.
  6. To populate additional pages for the book you just created, click on the Add child page link at the bottom of the page, and follow directions in steps 2-8 from the section on How to add content for Pages.
  7. Before exiting the Edit view, check the section on Book outline at the bottom of the page. Corroborate that the Book and Parent item menus are correct.
  8. Save your work. Remember to always save your work.

Articles

Articles are for time-sensitive content like news or press releases.

  1. TODO
  2. Save your work. Remember to always save your work.

Note: This type of node will automatically be posted to Twitter every time' unless you specify otherwise. To prevent pushing out to Twitter, click on Post to twitter.com and uncheck the box before saving.

External projects

An external project is description or placeholder for a GO-related project. It should mainly be treated as a forwarding stub, unless said project has not yet gotten to the point where it has its own pages.

  1. TODO
  2. Save your work. Remember to always save your work.

Highlighted terms

Highlighted, or otherwise special, GO term for public consumption.

  1. TODO
  2. Save your work. Remember to always save your work.

Note: This type of node will automatically be posted to Twitter every time' unless you specify otherwise. To prevent pushing out to Twitter, click on Post to twitter.com and uncheck the box before saving.

How to edit content

All non-book content

This is rather easier than content generation.

  1. Log in
  2. Navigate to the page that you want to edit, either directly or through Find content
  3. Click on the Revisions tab
  4. Make your desired changes, just as if you were creating the content
  5. Save your work. Remember to always save your work

Books

Books can be edited either by editing individual nodes (tedious) or using the method outlined below.

  1. Login
  2. Click Find content in navigation
  3. Click the "Books" tab
  4. Select the edit order and title link for the book that you wanted to edit
  5. On this page you may change order and nesting by dragging and dropping items; you may also rename the individual "chapter" titles
  6. Save your work. Remember to always save your work.

Versions and reversions

All nodes are currently setup to create new revisions after saving when editing, so go ahead and try that change. To roll back to a previous revision:

  1. Login
  2. Navigate to said page
  3. Click on the Revisions tab
  4. View the revisions by clicking on the links under Revision
  5. Revert by clicking the revert link under Operations

Style guide

Logos

Logos in projects will be cropped over 220x165. If you're having trouble getting getting your logo into an appropriate format, contact Seth or Moni for some help.

There's something I want! / It's not working!

  • We're still testing the new site and its workflows (thank you!), so not all of the pieces will fit perfectly yet. If there is something that you'd like (a new tag, a larger icon), please contact Seth or Moni to see if they can help you out.
  • If something seems to be broken, it might not just be you. Please contact Seth or Moni before frustration sets in so we can try and work out what it going on (or manage your expectations).
  • Keep in mind that these instructions and the current state of the site might fall out of sync. If that's the case, contact Seth or Moni to see if they can fox or update things.