Task #1084

News for OpenSearch (translate to english)

Added by Susanne Moog almost 5 years ago. Updated over 2 years ago.

Status:Closed Start date:2008-07-17
Priority:Should have Due date:2008-07-31
Assignee:Susanne Moog % Done:

100%
Category:-
Target version:sprint 2008/07 Estimated time:0.00 hour
Tags:
Votes: 0

Description

TYPO3 browser search

There is a new possibility to access the most important TYPO3 resources. Martin Holtz of the docTeam has programmed an openSearch for TYPO3. For those of you who don't know OpenSearch: These are the browsers searches that you find in firefox and IE in the upper right corner.

With the TYPO3 search you can search through wiki.typo3.org, the whole extension list on typo3.org, through forge.typo3.org, in TSref, in the API and in the (german) forum at Mittwald Medien.

A little example of how to use the search:
You just enter "keyword searchword" into the input field. Depending on the keyword you change where to look for your searchword. Entering "ext tt_news" gets you to the result page you also come to when you search on typo3.org -> Extensions. For an API search it would be e.g. "api typolink". If you have multiple words to search for it would be like "ext news feed", so the first word is always taken as keyword and all words after that as what you actually want to search. When not using a keyword the search defaults to wiki search.

The search even has a nice auto-completion feature for expressions out of the TSref. So if you are not quite sure how an option is spelled you can use that feature to show you. All in all a very nice tool for finding answers to TYPO3 questions.

Please note that the whole search tool is in expiremental state, therefore any feedback is appreciated. If you happen to have any questions, positive or negative feedback or anything else you just wish to say do it at the corresponding wiki1 page. There you can also learn how to install and use the search.

ABOUT THE DOCTEAM:
The DocTEAM keeps the documentation effort focussed the right way to support documentation-writers. Want to help? Just join us! [2]

[1] http://wiki.typo3.org/OpenSearch
[2] http://forge.typo3.org/projects/show/team-docteam

Es gibt eine neue Möglichkeit auf die wichtigsten TYPO3-Ressourcen schnell und einfach zuzugreifen. Martin Holtz vom DocTeam hat für TYPO3 eine eigene OpenSearch geschrieben. Für alle die jetzt denken "hä? OpenSearch???": OpenSearch, das sind die Browsersuchen, also die Suchen, die im Firefox und im Internet Explorer über das Suchfeld rechts oben erreichbar sind.

Über die TYPO3-Suche können das TYPO3-Wiki, die Extension-Liste, forge.typo3.org, die TSref, die TYPO3-API und das Forum von Mittwald Medien durchsucht werden.

Ein kleines Beispiel:
Bei Eingabe von "ext tt_news" kommt man auf die gleiche Seite, als hätte man unter www.typo3.org auf Extensions geklickt und dann dort "tt_news" in das Suchfeld eingegeben. Für eine Suche in der API tippt man z.B. "api typolink". Weitere Suchwörter können einfach angehangen werden, zum Beispiel "ext news feed". Wird kein Keyword angegeben, sucht man automatisch im Wiki, ist der Suchbegriff in der TSref vorhanden, wird man dorthin weitergeleitet.

Für Suchbegriffe aus der TSref gibt es sogar automatische Vorschläge, d.h. wenn man sich bei der Schreibweise oder dem genauen Namen nicht ganz sicher ist, hilft die Suche auch dabei. Alles in allem ein nettes Tool, um Suchen und Finden rund um TYPO3 zu beschleunigen.

Bitte beachten: Die Suche ist zur Zeit noch im experimentellen Status. Bei Fragen, Anregungen, Lob und Kritik einfach im Wiki1 melden, dort gibt es auch die Suche inklusive Anleitung.

DAS DOCTEAM:
Das DocTeam koordiniert die Dokumentationsarbeit und versucht so, für eine bessere, verständlichere und vollständigere Dokumentation zu sorgen. Ihr möchtet helfen? Dann macht einfach mit! [2]

[1] http://wiki.typo3.org/De:OpenSearch
[2] http://forge.typo3.org/projects/show/team-docteam

History

#1
Updated by Susanne Moog almost 5 years ago

  • Status changed from Accepted to Needs Feedback
  • Assignee changed from Susanne Moog to DocTeam
  • % Done changed from 0 to 90

Would someone review both news texts? Thanks.

#2
Updated by Virgil Huston almost 5 years ago

  • Assignee changed from DocTeam to Virgil Huston

#3
Updated by Daniel Brüßler almost 5 years ago

very good text, Susanne!

you can change this:
experimental state -> beta-state

Cheers!
Daniel

#4
Updated by Virgil Huston almost 5 years ago

English editing: See comment/question below. Otherwise, very good!

Description

TYPO3 browser search

There is a new possibility to access the most important TYPO3 resources. Martin Holtz of the docTeam has programmed an openSearch for TYPO3. For those of you who don't know OpenSearch: These are the browser's searches that you find in Firefox and IE in the upper right corner.

With the TYPO3 search you can search through wiki.typo3.org, the whole extension list on typo3.org, through forge.typo3.org, in TSref, in the API, and in the (german) forum at Mittwald Medien.

A little example of how to use the search:
You just enter "keyword" "searchword" into the input field. Depending on the keyword, you change where to look for your searchword. Entering "ext tt_news" gets you to the result page you also come to when you search on typo3.org -> Extensions. For an API search, it would be p.e. "api typolink". When not using a keyword, the search defaults to wiki search.

Virgil's comment: The above paragraph is confusing. It says to enter "keyword" "searchword" to specify where you want to search. Is the following a valid search in the typo3.org -> Extensions: "ext" "tt_news". Or is the example given correct: "ext tt_news"? Or are both correct? What happens if you have multiple words to search for?

The search even has a nice auto-completion feature for expressions out of the TSref. So if you are not quite sure how an option is spelled you can use that feature to show you. All in all a very nice tool for finding answers to TYPO3 questions.

Please note that the whole search tool is in an experimental state, therefore any feedback is appreciated. If you happen to have any questions, positive or negative feedback, or anything else you just wish to say, do it at the corresponding wiki1 page. There you can also learn how to install and use the search.

ABOUT THE DOCTEAM:
The DocTEAM keeps the documentation effort focussed the right way to support documentation-writers. Want to help? Just join us! [2]

[1] http://wiki.typo3.org/OpenSearch
[2] http://forge.typo3.org/projects/show/team-docteam

#5
Updated by Virgil Huston almost 5 years ago

  • Assignee changed from Virgil Huston to Susanne Moog

#6
Updated by Susanne Moog almost 5 years ago

  • Assignee changed from Susanne Moog to Virgil Huston

Virgil's comment: The above paragraph is confusing. It says to enter "keyword" "searchword" to specify where you want to search. Is the following a valid search in the typo3.org -> Extensions: "ext" "tt_news". Or is the example given correct: "ext tt_news"? Or are both correct? What happens if you have multiple words to search for?

Hi Virgil,

the example is correct "ext tt_news", with the first you specify where to search, with the second you say what you are searching for. If you have multiple words to search for it would be like "ext news feed", so the first word is always taken as keyword and all words after that as what you actually want to search. Is that clearer now? Do you have a suggestion how to phrase it?

Thanks for reading and correcting.

Susanne

#7
Updated by Virgil Huston almost 5 years ago

I think the problem was the use of two different examples: "keyword" "search" and "keyword search". So, I recommend changing

The above paragraph is confusing. It says to enter "keyword" "searchword" to specify where you want to search.

to

The above paragraph is confusing. It says to enter "keyword searchword" to specify where you want to search.

Then, I would add at the end of the paragraph:

If you have multiple words to search for it would be like "ext news feed", so the first word is always taken as keyword and all words after that as what you actually want to search.

Also, what does p.e. mean?

Thanks!

#8
Updated by Virgil Huston almost 5 years ago

  • Assignee changed from Virgil Huston to Susanne Moog

#9
Updated by Virgil Huston almost 5 years ago

Oops, I made a mistake in the first part, it should be:

I think the problem was the use of two different examples: "keyword" "search" and "keyword search". So, I recommend changing

You just enter "keyword" "searchword" into the input field.

to

You just enter "keyword searchword" into the input field.

Then, I would add at the end of the paragraph:

If you have multiple words to search for it would be like "ext news feed", so the first word is always taken as keyword and all words after that as what you actually want to search.

Also, what does p.e. mean?

Thanks!

#10
Updated by Susanne Moog almost 5 years ago

  • Assignee changed from Susanne Moog to Virgil Huston

I corrected the original text now and added the paragraph about multiple lines... if it is ok now, please assign it back to me and change status to resolved.

Oh and p.e. is french for "par exemple" = for example (e.g.) -- I got confused by all the different terms in my head... changed it to e.g. now.

#11
Updated by Virgil Huston almost 5 years ago

  • % Done changed from 90 to 100

#12
Updated by Virgil Huston almost 5 years ago

  • Status changed from Needs Feedback to Resolved
  • Assignee changed from Virgil Huston to Susanne Moog

Thanks Susanne, looks great!

#13
Updated by Susanne Moog almost 5 years ago

  • Status changed from Resolved to Closed

#14
Updated by Daniel Brüßler over 3 years ago

  • Due date set to 2008-07-31
  • Category changed from 168 to 659
  • Target version set to sprint 2008/07

Also available in: Atom PDF