aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog25
-rw-r--r--doc/INSTALL.txt8
-rw-r--r--doc/README.rst4
-rw-r--r--doc/UPGRADE.txt4
-rw-r--r--doc/allinone.rst31
-rw-r--r--doc/configuration.rst58
-rw-r--r--doc/developers/release-new-version.rst12
-rw-r--r--doc/index.rst5
8 files changed, 131 insertions, 16 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index cde9e61..f963ca2 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,28 +1,39 @@
ChangeLog for SemantiScuttle
============================
+.. contents::
-0.98.0 - 2011-XX-XX
+0.98.1 - 2011-XX-XX
+-------------------
+- Fix bug #3375635: XML parsing problem in top.inc.php
+- Fix bug #3375428: Forgot to remove some old dojo files
+- Fix bug #3160512: Make SemanticScuttle work with FastCGI
+
+
+0.98.0 - 2011-07-21
-------------------
- Switch to jQuery and drop dojo
+- Implement request #2928950: Private keys for RSS feeds (Mark Pemberton)
+- Implement request #3164348: Configurable default privacy (Brett Dee)
+- Implement request #1989987: Theming support
+- Implement request #3054906: Show user's full name instead of nickname
+- Implement patch #3059829: update ``FR_CA`` translation
- Fix bug #3187177: Wrong URL / Export XML Bookmarks
-- Fix bug in ``getTagsForBookmarks()`` that fetched all tags
- Fix bug #3097187: Using opensearch with two tags does not work in Firefox
- Fix bug #3251877: French translation JavaScript Bug when editing bookmarks
- Fix bug #3168521: Title of tag-filtered RSS Feed is broken
- Fix bug #2853627: Javascript warning
-- Implement request #1989987: Theming support
-- Implement request #3054906: Show user's full name instead of nickname
-- Implement patch #3059829: update ``FR_CA`` translation
+- Fix bug in ``getTagsForBookmarks()`` that fetched all tags
+- Fix privacy issue when fetching tags of several users
+- Fix Google custom search XML
- Show error message on mysqli connection errors
- Update php-gettext library to 1.0.10
- ``api/posts/add`` respects the "replace" parameter now
-- Fix privacy issue when fetching tags of several users
-- Fix Google custom search XML
- Only URLs with an allowed protocol may be added to the database
- Support HTTPS connections when ``$root`` is not configured
- SQL schema version table to ease future database upgrades
- Documentation is written with rST (reStructuredText) now
+- Support per-host configuration files
0.97.2 - 2011-02-17
diff --git a/doc/INSTALL.txt b/doc/INSTALL.txt
index 5afc732..fbd44f9 100644
--- a/doc/INSTALL.txt
+++ b/doc/INSTALL.txt
@@ -22,7 +22,7 @@ Installation instructions
on the shell ("semanticscuttle" being the database name)
3. Copy ``data/config.php.dist`` to ``data/config.php`` and modify it as
- necessary.
+ necessary. See configuration_ for more information.
4. Make the cache directory writable by your web server.
For example, run ::
@@ -31,6 +31,12 @@ Installation instructions
on the shell.
5. Set the ``www/`` directory as document root in your web server,
restart the web server.
+6. That's all! Visit your SemanticScuttle installation web site now
+ with your browser.
+7. Register a user and add bookmarks.
+
+
+.. _configuration: configuration.html
Ugly www directory in URLs
diff --git a/doc/README.rst b/doc/README.rst
index 0c7befe..7702400 100644
--- a/doc/README.rst
+++ b/doc/README.rst
@@ -4,7 +4,9 @@ SemanticScuttle 0.98
A social bookmarking tool experimenting with new features
like structured tags or collaborative descriptions of tags.
-https://sourceforge.net/projects/semanticscuttle/
+- Home page: http://semanticscuttle.sourceforge.net/
+- Project page: https://sourceforge.net/projects/semanticscuttle/
+- Demo: http://semanticscuttle.sourceforge.net/demo/
Available under the GNU General Public License
diff --git a/doc/UPGRADE.txt b/doc/UPGRADE.txt
index 0e570e5..b144af2 100644
--- a/doc/UPGRADE.txt
+++ b/doc/UPGRADE.txt
@@ -2,6 +2,7 @@
Upgrading SemanticScuttle from a previous version
=================================================
+.. contents::
From version 0.97 to 0.98
=========================
@@ -9,6 +10,9 @@ 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
=========================
diff --git a/doc/allinone.rst b/doc/allinone.rst
new file mode 100644
index 0000000..e5ca3c7
--- /dev/null
+++ b/doc/allinone.rst
@@ -0,0 +1,31 @@
+=============================
+SemanticScuttle documentation
+=============================
+
+.. contents::
+
+First reads
+===========
+.. include:: README.rst
+.. include:: INSTALL.txt
+.. include:: UPGRADE.txt
+
+
+
+Features
+========
+.. include:: authentication.rst
+.. include:: ssl-client-certificates.rst
+.. include:: themes.rst
+
+
+
+Developer documentation
+=======================
+.. include:: developers/rules.rst
+.. include:: developers/api.rst
+.. include:: developers/debugging.rst
+.. include:: developers/release-new-version.rst
+.. include:: developers/running-unit-tests.rst
+.. include:: developers/translation.rst
+.. include:: ChangeLog
diff --git a/doc/configuration.rst b/doc/configuration.rst
new file mode 100644
index 0000000..f457ebb
--- /dev/null
+++ b/doc/configuration.rst
@@ -0,0 +1,58 @@
+===================
+Configuration files
+===================
+
+SemanticScuttle uses at least two configuration files:
+
+1. Default configuration file ``config.default.php``
+2. Custom configuration file ``config.php``
+
+
+The **default configuration** file contains sensible defaults for most users
+that do not need to be changed to get started.
+
+Never change it - it will get overwritten with the next update.
+If you want to change values in it, copy them into your personal
+``config.php`` file - updates to SemanticScuttle will not change that one.
+
+The **custom configuration** file, ``config.php`` is created by copying the
+shipped ``config.php.dist`` file and modifying the values in there.
+
+It consists of the configuration directives that should be set on every
+fresh installation.
+
+
+
+Configuration scenarios
+=======================
+
+Simple installation
+-------------------
+Put your configuration file in ``data/config.php``.
+If you installed SemanticScuttle's PEAR package, use::
+
+ $ pear config-get data_dir
+ /usr/share/php/data
+
+to find the data directory location and append ``SemanticScuttle/`` to it.
+In this case, the configuration file has to be in::
+
+ /usr/share/php/data/SemanticScuttle/config.php
+
+
+The configuration file may also be saved into::
+
+ /etc/semanticscuttle/config.php
+
+
+Multiple SemanticScuttle instances
+----------------------------------
+The files of one single SemanticScuttle installation may be shared
+for several SemanticScuttle instances.
+
+To be able to configure them differently, SemanticScuttle supports
+per-host configuration files:
+
+- ``data/config.$hostname.php``
+- ``/etc/semanticscuttle/config.$hostname.php``
+
diff --git a/doc/developers/release-new-version.rst b/doc/developers/release-new-version.rst
index 4b2540a..a5e77dc 100644
--- a/doc/developers/release-new-version.rst
+++ b/doc/developers/release-new-version.rst
@@ -2,18 +2,18 @@ How to release a new version of SemanticScuttle
===============================================
0. Run unit tests and verify that all of them pass
-1. Update doc/ChangeLog
-2. Update doc/UPGRADE.txt
-3. Update version in data/templates/about.tpl.php,
- build.xml and doc/README.txt
+1. Update ``doc/ChangeLog``
+2. Update ``doc/UPGRADE.txt``
+3. Update version in ``data/templates/about.tpl.php``,
+ ``build.xml`` and ``doc/README.rst``
4. Create a release zip file via the build script:
- Just type "phing".
+ Just type "``phing``".
5. Make a test installation from your zip file with a fresh
database. Register a user, add bookmarks etc.
6. When all is fine, it's time to release.
The build script takes care for most of the
tasks.
- Run "phing release", and it will upload the release to
+ Run "``phing release``", and it will upload the release to
sourceforge and create a svn tag.
7. Write announcement mail to the SemanticScuttle mailing list
semanticscuttle-devel@lists.sourceforge.net
diff --git a/doc/index.rst b/doc/index.rst
index 1b8feea..0a53680 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -20,10 +20,12 @@ Features
- `Custom user authentication`__
- `SSL Client certificates`__
- Themes__
+- `Configuration files`__
__ authentication.html
__ ssl-client-certificates.html
__ themes.html
+__ configuration.html
@@ -35,6 +37,7 @@ Developer documentation
- `How to release a new version`__
- `Running unit testes`__
- `How to translate SemanticScuttle`__
+- `ChangeLog`__
__ developers/rules.html
__ developers/api.html
@@ -42,4 +45,4 @@ __ developers/debugging.html
__ developers/release-new-version.html
__ developers/running-unit-tests.html
__ developers/translation.html
-
+__ ChangeLog.html