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

From GO Wiki
Jump to: navigation, search
Line 36: Line 36:
 
* [http://www.oboedit.org/oe2/userguide/html/Link_Filters_vs_Term_Filters.htm Link Filters vs Term Filters] (Jen - ok)
 
* [http://www.oboedit.org/oe2/userguide/html/Link_Filters_vs_Term_Filters.htm Link Filters vs Term Filters] (Jen - ok)
 
* [http://www.oboedit.org/oe2/userguide/html/Building_a_Filter.htm 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
 
* [http://www.oboedit.org/oe2/userguide/html/Building_a_Filter.htm 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
** [http://www.oboedit.org/oe2/userguide/html/Setting_the_Filter_Mode.htm 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
+
** [http://www.oboedit.org/oe2/userguide/html/Setting_the_Filter_Mode.htm 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 (It really is deleted; not sure why you're still seeing it.  --Nomi)
 
** [http://www.oboedit.org/oe2/userguide/html/Term_Filters.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/Term_Filters.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/Link_Filters.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/Link_Filters.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/Compound_Filtering.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/Compound_Filtering.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/Reusing_Filters.htm Reusing Filters] (ok -midori)
 
** [http://www.oboedit.org/oe2/userguide/html/Reusing_Filters.htm Reusing Filters] (ok -midori)
* [http://www.oboedit.org/oe2/userguide/html/Using_Filters.htm Using Filters] (empty, probably on purpose -midori)
+
* [http://www.oboedit.org/oe2/userguide/html/Using_Filters.htm Using Filters] (empty, probably on purpose -midori) (Deleted--I hate these stupid content-free pages.  --Nomi)
 
** [http://www.oboedit.org/oe2/userguide/html/Searching.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/Searching.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/Filtering.htm 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)
 
** [http://www.oboedit.org/oe2/userguide/html/Filtering.htm 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)
Line 47: Line 47:
 
** [http://www.oboedit.org/oe2/userguide/html/Global_Filters___Renderers.htm Global Filters & Renderers] (ok -midori)
 
** [http://www.oboedit.org/oe2/userguide/html/Global_Filters___Renderers.htm Global Filters & Renderers] (ok -midori)
 
** [http://www.oboedit.org/oe2/userguide/html/Other_Uses_of_Filters.htm Other Uses of Filters] (ok -midori)
 
** [http://www.oboedit.org/oe2/userguide/html/Other_Uses_of_Filters.htm Other Uses of Filters] (ok -midori)
** [http://www.oboedit.org/oe2/userguide/html/Custom_Search_Buttons.htm 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
+
** [http://www.oboedit.org/oe2/userguide/html/Custom_Search_Buttons.htm 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 (Deleted --Nomi)
 
* [http://www.oboedit.org/oe2/userguide/html/Advanced_Searching.htm 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
 
* [http://www.oboedit.org/oe2/userguide/html/Advanced_Searching.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/HTML_Rendering.htm 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
 
** [http://www.oboedit.org/oe2/userguide/html/HTML_Rendering.htm 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

Revision as of 13:51, 7 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 (It really is deleted; not sure why you're still seeing it. --Nomi)
    • 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) (Deleted--I hate these stupid content-free pages. --Nomi)
    • 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 (Deleted --Nomi)
  • 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)