summaryrefslogtreecommitdiff
path: root/doc/README.txt
blob: a7f9b66e7d4e329d7d45f61a3cd3b741177a41c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
SemanticScuttle 0.94
====================
A social bookmarking tool experimenting with new features
like structured tags or collaborative descriptions of tags.

https://sourceforge.net/projects/semanticscuttle/

Available under the GNU General Public License


Installation
------------
See INSTALL.txt


Upgrading from a previous version
---------------------------------
See UPGRADE.txt


Public API
----------
Scuttle supports most of the del.icio.us API [1].
Almost all of the neat tools made for that system can be modified
to work with your SemanticScuttle installation. If you find a tool
that won't let you change the API address, ask the creator to add
this setting. You never know, they might just do it.

[1] http://del.icio.us/doc/api


Translations
------------
Scuttle is available in the following languages :

English     en-GB   100% (Default)
Chinese     zh-CN   86%
Danish      dk-DK   100%
Dutch       nl-NL   68%
French      fr-FR   100%
German      de-DE   100%
Hindi       hi-IN   100%
Italian     it-IT   89%
Japanese    ja-JP   100%
Lithuanian  lt-LT   100%
Portuguese  pt-BR   100%
Spanish     es-ES   94%

Translations are managed with gettext <includes/php-gettext>.

To provide additional translations:
- execute of of the scripts in <includes/php-gettext/bin/>
  for example to complete french (France) translation on a
  GNU/Linux system, type
  ./gettexts.sh fr_FR
- then edit the file <locales/fr_FR/LC_MESSAGES/messages.po>
  with poedit
  (that will update <locales/fr_FR/LC_MESSAGES/messages.mo>)


Links
-----
http://semanticscuttle.wiki.sourceforge.net/
 - further documentation

http://sourceforge.net/forum/forum.php?forum_id=759510
 - support and help questions

https://sourceforge.net/mailarchive/forum.php?forum_name=semanticscuttle-devel
 - development mailing list instructions

http://sourceforge.net/forum/forum.php?forum_id=759511
 - suggestions for SemanticScuttle

http://sourceforge.net/tracker/?group_id=211356&atid=1017430
 - bug reports

https://sourceforge.net/tracker/?group_id=211356&atid=1017433
 - feature requests

https://sourceforge.net/tracker/?group_id=211356&atid=1017432
 - patches


Known issues
------------

Number of bookmarks always 0: "0 bookmark(s)"
 This issue occurs when debug mode is enabled.
 Technically, this is because the database layers DEBUG_EXTRA gets
 enabled through debug mode.



End user docs
-------------
Unfortunately, there are no real end user docs yet.
Here is a list of interesting things:
- Bookmarklets: Text selection is used as description
- Tag nesting: Paris > France > World
- Tag alias: Deutschland = Germany