summaryrefslogtreecommitdiff
path: root/doc/UPGRADE.txt
blob: 1a0b9644dd4bae35d93b20caf3a82c2dead37186 (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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
=================================================
Upgrading SemanticScuttle from a previous version
=================================================


From version 0.97 to 0.98
=========================
Database updates
----------------
Apply ``data/schema/6.sql``

    ALTER TABLE `sc_users` ADD `privateKey` VARCHAR(33) NULL;
    CREATE UNIQUE INDEX `privateKey` ON `sc_users` (`privateKey`);


From version 0.96 to 0.97
=========================
No database changes necessary.


From version 0.95 to 0.96
=========================
Database updates
----------------
Apply ``data/schema/5.sql``

API
---
The method signatures of ``addBookmark()`` and ``updateBookmark()``
changed due to the addition of the ``$short`` parameter.

We got complaints about the changed file structure, and people told
us that they just cannot set the document root to ``www/``, because they
are not admins on their HTTP server. This is a valid point, and
with 0.96.0 you can easily change it. See `INSTALL.txt`_ for more information
about moving ``www/``.

.. _INSTALL.txt: INSTALL.html


From version 0.94 to 0.95
=========================
The file structure completely changed in 0.95.0 compared
to previous versions. We recommend that you start with a
fresh installation, just copying over your ``config.php`` file.
Set your web server document root directory to ``www/``.

Yes, we kind of lost the ability to run SemanticScuttle
in a subdirectory of a hostname. This functionality will
be back in one of the next releases, but for now, you have
to live with it.

Update your database
--------------------
Apply ``data/schema/4.sql``.

Currently, only MySQL can be used as database backend.
All other DBMS (database management systems) have not been
tested except for PostgreSQL, and SemanticScuttle fails there.

Translation
-----------
The ``de_AT`` translation has been re-added. This is because
``de_AT`` provides a rather ugly "official German" style,
while the normal ``de_DE`` is friendlier. Choose what you like.


From version 0.93 to 0.94
=========================

- Nothing changed except for the default configuration file.
  It is recommended to start with a fresh config file,
  but not neccesary. Old config files still work.
- If you used translation ``de_AT``, please switch to ``de_DE``.
  ``de_AT`` was moved to ``de_DE`` and ``de_AT`` has been removed.


From version 0.92 to 0.93
=========================

- Backup your database
- Make a copy from your SemanticScuttle Web directory
- Upgrade your current configuration file (``config.inc.php``) with respect to ``config.inc.php.example`` ::

  $footerMessage      = ''; #HTML message appearing at the bottom of the page (just above SemanticScuttle credits)
  $sidebarTopMessage  = ''; #HTML message appearing at the top of the sidebar
  $sidebarBottomMessage = ''; #HTML message appearing at the bottom of the sidebar
  $adminsCanModifyBookmarksFromOtherUsers = true;  # 'true' if admin users can edit or delete bookmarks belonging to other users. Else 'false'.
  $adminsAreAdvisedTagsFromOtherAdmins = false;  # 'true' if tags from other admins are proposed to each admin (in add/edit a bookmark page). Else 'false'.
  $defaultPerPageForAdmins = 20; # default number of bookmarks per page for admins (-1 means no limit)


From version 0.91 to 0.92
=========================
Message: this version modifies the database to UTF-8 charset. The idea is to convert the content (through BLOB type) and then to change the tables' charsets.

- Backup your database
- Make a copy from your SemanticScuttle Web directory
- Upgrade your database by applying ``data/schema/3.sql``
- Upgrade your current configuration file (``config.inc.php``) with respect to ``config.inc.php.example``

  - Add variable ::

      $descriptionAnchors = array("author", "isbn", "address"=>"[address][street][/street][city][/city][/address]"); #add a possible anchor (structured content) for bookmarks' description field

  - Add variable ::

      $enableCommonTagDescriptionEditedByAll = true; #true mean everybody can edit common description. Else just the admins can do it.
  - Add variable ::

      $googleAnalyticsCode = ''; #Allow GoogleAnalytics tracker https://www.google.com/analytics/


From version 0.90 to 0.91
=========================
- Backup you database
- Make a copy from your SemanticScuttle Web directory
- Upgrade your database by applying ``data/schema/2.sql``
- Upgrade your current configuration file (``config.inc.php``) with respect to ``config.inc.php.example``

  - Delete last line ::

      include_once('debug.inc.php');

  - Add variable::

      $menu2Tags = array('example', 'of', 'menu', 'tags');

  - Add variable::

      $debugMode = true; # if true, show debug messages


From version 0.89 to 0.90
=========================

- Backup you database
- Make a copy from your SemanticScuttle Web directory

- Upgrade your current configuration file (config.inc.php) with respect to config.inc.php.example

  add these lines under ``$enableWebsiteThumbnails = false; # enableWebsiteThumbnails {true|false}``::

    $thumbnailsUserId = '';
    $thumbnailsKey = '';


From version 0.88 to 0.89
=========================

- Backup you database
- Make a copy from your SemanticScuttle Web directory
- Upgrade your database by applying ``data/schema/1.sql``
- Upgrade your current configuration file (``config.inc.php``) with respect to ``config.inc.php.example``

  - add line::

	$sizeSearchHistory = 10;

  - add sidebar block index line::

	$index_sidebar_blocks = array('search','menu','users','popular');

  - add line::
	$enableGoogleCustomSearch = true;