Difference between revisions of "OBO-Edit: Documentation Week"

From GO Wiki
Jump to: navigation, search
Line 56: Line 56:
 
* [http://www.oboedit.org/oe2/userguide/html/Text_Editing.htm Text Editing] (would be nice to have bug fix for SF 2010579; otherwise ok -midori)
 
* [http://www.oboedit.org/oe2/userguide/html/Text_Editing.htm Text Editing] (would be nice to have bug fix for SF 2010579; otherwise ok -midori)
 
* [http://www.oboedit.org/oe2/userguide/html/Structural_Editing.htm Structural Editing] (Nomi - done (just this top-level page--not the pages in this section))
 
* [http://www.oboedit.org/oe2/userguide/html/Structural_Editing.htm Structural Editing] (Nomi - done (just this top-level page--not the pages in this section))
** [http://www.oboedit.org/oe2/userguide/html/The_Interface.htm The Interface]
+
** [http://www.oboedit.org/oe2/userguide/html/The_Interface.htm The Interface] (updated; now ok -midori)
 
** [http://www.oboedit.org/oe2/userguide/html/Adding_New_Terms.htm Adding New Terms] (ok -midori)
 
** [http://www.oboedit.org/oe2/userguide/html/Adding_New_Terms.htm Adding New Terms] (ok -midori)
 
** [http://www.oboedit.org/oe2/userguide/html/Adding_New_Relationships.htm Adding New Relationships] (ok -midori)
 
** [http://www.oboedit.org/oe2/userguide/html/Adding_New_Relationships.htm Adding New Relationships] (ok -midori)
Line 89: Line 89:
  
 
Working with Data Adapters
 
Working with Data Adapters
* [http://www.oboedit.org/oe2/userguide/html/Introduction_to_Adapters.htm Introduction to Adapters]
+
* [http://www.oboedit.org/oe2/userguide/html/Introduction_to_Adapters.htm Introduction to Adapters] (ok -midori)
* [http://www.oboedit.org/oe2/userguide/html/Loading___Saving.htm Loading & Saving]
+
* [http://www.oboedit.org/oe2/userguide/html/Loading___Saving.htm Loading & Saving] (ok -midori)
* [http://www.oboedit.org/oe2/userguide/html/The_Basic_Flat_File_Interface.htm The Basic Flat File Interface]
+
* [http://www.oboedit.org/oe2/userguide/html/The_Basic_Flat_File_Interface.htm The Basic Flat File Interface] (ok -midori)
* [http://www.oboedit.org/oe2/userguide/html/The_OBO_Adapter.htm The OBO Adapter]
+
* [http://www.oboedit.org/oe2/userguide/html/The_OBO_Adapter.htm The OBO Adapter] (updated; filter links may need further update -midori)
* [http://www.oboedit.org/oe2/userguide/html/The_GO_Flat_File_Adapter.htm The GO Flat File Adapter]
+
* [http://www.oboedit.org/oe2/userguide/html/The_GO_Flat_File_Adapter.htm The GO Flat File Adapter] (ok -midori)
* [http://www.oboedit.org/oe2/userguide/html/The_Serial_Adapter.htm The Serial Adapter]
+
* [http://www.oboedit.org/oe2/userguide/html/The_Serial_Adapter.htm The Serial Adapter] (ok -midori)
* [http://www.oboedit.org/oe2/userguide/html/Custom_Data_Adapters.htm Custom Data Adapters]
+
* The OBO OWL Adapter '''(need new page)'''
 +
* The OWL URL Reader '''(need new page)'''
 +
* The GO Association File Adapter '''(need new page)'''
 +
* [http://www.oboedit.org/oe2/userguide/html/Custom_Data_Adapters.htm Custom Data Adapters] (ok once we add the pages needed for other adapters -midori)
  
 
The Reasoner (Amina)
 
The Reasoner (Amina)
Line 141: Line 144:
 
* [http://www.oboedit.org/oe2/userguide/html/Java_Options_on_the_Command_line.htm Java Options on the Command-line]
 
* [http://www.oboedit.org/oe2/userguide/html/Java_Options_on_the_Command_line.htm Java Options on the Command-line]
  
[http://www.oboedit.org/oe2/userguide/html/Frequently_Asked_Questions.htm Frequently Asked Questions]
+
[http://www.oboedit.org/oe2/userguide/html/Frequently_Asked_Questions.htm Frequently Asked Questions] (just a header-midori)
 
* [http://www.oboedit.org/oe2/userguide/html/How_Do_I_Make_a__Slim__Ontology_.htm How Do I Make a 'Slim' Ontology?]
 
* [http://www.oboedit.org/oe2/userguide/html/How_Do_I_Make_a__Slim__Ontology_.htm How Do I Make a 'Slim' Ontology?]
** [http://www.oboedit.org/oe2/userguide/html/Creating_Your_Own_GO_Slim_in_OBO_Edit.htm Creating Your Own GO Slim in OBO-Edit]
+
** [http://www.oboedit.org/oe2/userguide/html/Creating_Your_Own_GO_Slim_in_OBO_Edit.htm Creating Your Own GO Slim in OBO-Edit] (minor updates; filter links may also need updating after searh/filter reorg -midori)
* [http://www.oboedit.org/oe2/userguide/html/How_Do_I_Find_Terms_Without_an_is_a_Parent_.htm How Do I Find Terms Without an is_a Parent?]
+
* [http://www.oboedit.org/oe2/userguide/html/How_Do_I_Find_Terms_Without_an_is_a_Parent_.htm How Do I Find Terms Without an is_a Parent?] (midori)
* [http://www.oboedit.org/oe2/userguide/html/How_Do_I_Spell_Check_.htm How Do I Spell Check?]
+
* [http://www.oboedit.org/oe2/userguide/html/How_Do_I_Spell_Check_.htm How Do I Spell Check?] (what is the current status of spell check? I know it's been disabled, but was there any plan to bring it back? No pressure; just useful to know for the docs -midori)
* [http://www.oboedit.org/oe2/userguide/html/How_Do_I_Not_Search_Obsoletes_.htm How Do I Not Search Obsoletes?]
+
* [http://www.oboedit.org/oe2/userguide/html/How_Do_I_Not_Search_Obsoletes_.htm How Do I Not Search Obsoletes?] (midori)

Revision as of 09:23, 4 July 2008

The OBO-Edit Working Group has agreed to devote the week of June 30th, 2008, to testing OBO-Edit2 and writing user documentation. We appreciate your help!

Please let everyone know what you're concentrating on in your testing, and which help pages you're working on, so we don't duplicate each others' work. You can enter this information below.

Help pages

Below is the table of contents listing the current OBO-Edit2 help pages. If you are working on a page or section, please put your name after it, and commit your changes to svn (or send them to Nomi) as soon as you're done. If you've checked a page and it's up-to-date, please put "(ok)" after it. If you think we should add a new help page (or delete an existing one) please tell Nomi.

Midori has done a draft of a reorganized table of contents. Please comment!

Please note: the user guide pages linked here are not updated automatically--they are updated manually by Nomi. If you want to see your recent changes reflected here, please ask Nomi to update these pages.

OBO-Edit User's Guide (intro)

Viewing Ontologies

Filtering, Rendering & Searching (Jen)

  • Filters (Jen - ok)
  • Link Filters vs Term Filters (Jen - ok)
  • Building Filters (Not empty--was wrong page. Needs updating) This page is hopelessly out of date; the Attribute, Comparison, and Aspect sections should be folded into the Advanced Search (or just "Search") page; then this page should be deleted. -midori
    • Setting the Filter Mode (Jen - This page deleted) It still shows up in my svn checkout, but deleting it is the right thing to do. -midori
    • Term Filters (Jen - part done - This documentation derails here because the filter button has not yet been added back and the ancestor/descendant menu has not been added back. I think it would make more sense to wait until this is complete to write the docs as screenshots will all soon be obsolete.) Actually, we could just lose this page. A lot of it duplicates the Building a Filter page, and both are superseded by the new search interface. -midori
    • Link Filters This could either be incorporated into Advanced Searching or kept separate; if we keep it separate, the screenshot and a few lines of text have to be updated. Let me know if you want me to do either. -midori
    • Compound Filtering Delete this page - it's completely, utterly, and happily superseded by the new search interface. It might be worth keeping the last section (move to the main search doc), on search speed, because I think that's still relevant. -midori
    • Reusing Filters (ok -midori)
  • Using Filters (empty, probably on purpose -midori)
    • Searching Out of date. Copy the last section (Saving Search Results to a File) over to the main search doc, then delete this page. -midori
    • Filtering What does OE2 do about root picking algorithms (last section)? Rest of this page is out of date; I can update it, but need to know what to do with the root-picking bit. (midori)
    • Rendering Partially out of date; need decision about "render button" feature (SF 1958908) to update. -midori
    • Global Filters & Renderers (ok -midori)
    • Other Uses of Filters (ok -midori)
    • Custom Search Buttons It looks like this page is entirely out of date, because it depends on the old XML layout system. If so, delete it. -midori
  • Advanced Searching (Nomi made a few changes) Because this search interface supersedes so much of the OE1 search documentation, this page could be renamed just 'Searching', or it could become the new 'Building a Filter' page. In any case, "advanced" no longer makes sense. Anyway, it looks nearly done, but would benefit from a bit more explanation of subqueries. I've added a couple of subheadings. Let me know if you want me to work on this any further. -midori
    • HTML Rendering (Jen - done: requires one more screenshot once ancestor/descendant menu is added to global filter interface.) This page should go under Rendering. -midori
    • Term Image Display Panel (Nomi - done) (Does this really belong under "Advanced Searching"? Is there a better place for it?) Hi Nomi, I wondered if it might make sense to have categories that mirror the categories under which the many components are grouped in the OBO-Edit menus. So, for example, Term Image Display Panel would be under the heading 'Viewers'. Does that seem good? (Jen) I think this should move to the "Tools" menu; it's neither an ontology viewer nor a search. (midori)

Editing

History (all ok)

Working with Data Adapters

The Reasoner (Amina)

Ontology Verification

Cross Products (Karen Eilbeck)

Expressions

Plugins

The Command Line

Frequently Asked Questions (just a header-midori)