[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

[TSVN] To all the FAQ writers

From: Lübbe Onken <l.onken_at_rac.de>
Date: 2005-03-08 11:56:39 CET

Hi Folks,

Just FYI: When you write an FAQ article, there's no need to repeat bigger
parts of title or content in the keywords. The fulltext search uses MySQL's
builtin fulltext search on title, content and keywords. This search function
is by default limited to strings longer than (longer equal?) four characters
because it shouldn't catch 'he, she, it, my, you, the' but typically doesn't
catch 'SSH, SSL, 404, ...' as well.
So I rewrote the phpMyFAQ search function that it runs an additional search
on the keywords if the default search doesn't yield a result. The keyword
search isn't limited to strings >= 4 characters and finds 'SSH, 404, ...'
What does that tell a FAQ writer?
In your keywords you should put:
- short (three letter) terms like 'SSH, 404', which aren't found by the
default search.
- variations of words people would search for, which don't appear in content
or title. Like 'repo' if the tite contains 'repository browser'
You shouldn't repeat the FAQ title or content.

The FAQ admin section doesn't have the 'short keyword search', only the user
section. Sorry, my lazyness...

I went through the apache error messages that I found and reduced them to
read: 'Error: "404 - not found"' without all the explanatory text around it,
to make the error number stand out better. A nice example is:

I consistently get the error: REPORT request failed on
'/repos/tortoisesvn/!svn/vcc/default' REPORT of
'/repos/tortoisesvn/!svn/vcc/default': 400 Bad Request
(http://svn.collab.net), ...

Error: "REPORT request failed on '...' REPORT of '...': 400 Bad Request

You can find it by searching for 'vcc, 400, report, request'

A really bad example that needs fixing is:

- Lübbe

  oo  // \\      "De Chelonian Mobile"
 (_,\/ \_/ \     TortoiseSVN
   \ \_/_\_/>    The coolest Interface to (Sub)Version Control
   /_/   \_\     http://tortoisesvn.tigris.org
To unsubscribe, e-mail: dev-unsubscribe@tortoisesvn.tigris.org
For additional commands, e-mail: dev-help@tortoisesvn.tigris.org
Received on Tue Mar 8 11:57:29 2005

This is an archived mail posted to the TortoiseSVN Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.