Bug 97136

Summary: Better documentation of kioslave format, especially number of needed slashes
Product: [Websites] docs.kde.org Reporter: Roland Seuhs <r>
Component: generalAssignee: Documentation Editorial Team <kde-doc-english>
Status: RESOLVED FIXED    
Severity: wishlist CC: davidbryant, tagwerk19, yurchor
Priority: NOR    
Version: 3.3   
Target Milestone: ---   
Platform: unspecified   
OS: Linux   
Latest Commit: Version Fixed In:

Description Roland Seuhs 2005-01-16 13:15:36 UTC
Version:           3.3 (using KDE 3.3.0, SuSE)
Compiler:          gcc version 3.3.3 (SuSE Linux)
OS:                Linux (i686) release 2.6.4-52-default

kioslaves all expect different formats, for example

file:/path
audiocd:/

expect one slash and fail with 2 slashes (actually file:// tries to search on smb?!) and

http://server.org/path
fish://user@server/path

expect 2 slashes and fail with one, while

gg:search term

works without a slash at all.

Even as an experienced user it is not intuitive to remember each format.

Currently if you type in just "http:" or "fish:" or any other, you get an error, it would be just great if you could get a tiny *example* of the format so you know where to put how many slashes/dots/semicolons
Comment 1 Thiago Macieira 2005-01-17 02:19:24 UTC
gg:, etc, aren't kioslaves. They aren't even URLs. For KDE 4, they'll lose the : to lessen the confusion.

One slash is now deprecated: three should be used. It means local host.

Two slashes are always followed by a hostname.

Three slashes means empty hostname. That means localhost.
Comment 2 Marek Laane 2007-08-12 00:29:34 UTC
Yeah, but is it explained somewhere?
Comment 3 Justin Zobel 2021-03-09 05:38:59 UTC
Thank you for the bug report.

As this report hasn't seen any changes in 5 years or more, we ask if you can please confirm that the issue still persists.

If this bug is no longer persisting or relevant please change the status to resolved.
Comment 4 Yuri Chornoivan 2021-03-09 07:28:39 UTC
(In reply to Justin Zobel from comment #3)
> Thank you for the bug report.
> 
> As this report hasn't seen any changes in 5 years or more, we ask if you can
> please confirm that the issue still persists.
> 
> If this bug is no longer persisting or relevant please change the status to
> resolved.

Actually, this is an upstream bug. In KDE documentation team, we are trying to be consistent and explain every KIO syntax. If somebody find the things that should be improved then please edit the docbooks directly on invent.kde.org and create merge requests. This is deadly easy.
Comment 5 David C. Bryant 2021-03-09 14:45:41 UTC
This is not really a bug. Poorly informed user.
Comment 6 tagwerk19 2021-03-15 21:01:39 UTC
Is there anything that describes "tags:"?

There seems to be complexities, cf:
   https://bugs.kde.org/show_bug.cgi?id=432004#c1
Comment 7 Yuri Chornoivan 2021-03-16 16:51:59 UTC
(In reply to tagwerk19 from comment #6)
> Is there anything that describes "tags:"?
> 
> There seems to be complexities, cf:
>    https://bugs.kde.org/show_bug.cgi?id=432004#c1

That's easy. You can create an MR with your changes (the "Edit" button) against this file:

https://invent.kde.org/frameworks/baloo/-/blob/master/docs/user/searching.md

Personally, I do not know how the users can find this file but it might happen they can.

The KDE documentation team has no responsibility for the developers who decided to write their user docs in Markdown.