https://github.com/schmidt/chiliproject_wiki_tabs
ChiliProject Plugin which allows you to add custom tabs that link to wiki pages
https://github.com/schmidt/chiliproject_wiki_tabs
Last synced: over 1 year ago
JSON representation
ChiliProject Plugin which allows you to add custom tabs that link to wiki pages
- Host: GitHub
- URL: https://github.com/schmidt/chiliproject_wiki_tabs
- Owner: schmidt
- License: other
- Created: 2012-09-24T08:00:14.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2012-09-25T06:28:57.000Z (over 13 years ago)
- Last Synced: 2025-01-29T19:49:16.709Z (over 1 year ago)
- Language: Ruby
- Homepage: https://github.com/finnlabs/chiliproject_wiki_tabs
- Size: 333 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rdoc
- Changelog: CHANGELOG.rdoc
Awesome Lists containing this project
README
= ChiliProject Wiki Tabs Plugin
This plugin provides the ability to add tabs linking to wiki pages on a
per-project basis. It also allows to remove the default wiki link from
the main menu, while the wiki itself is not deactivated.
It also adds links to the sidebar of each wiki page to directly create
a new page or a new child page of the current one.
== Requirements
This plugin aims to be compatible with
* ChiliProject 1.1 and the following
* ChiliProject 2.1 and the following
* ChiliProject 3.0 and the following
Please note, that there is a bug when running the plugin with ChiliProject 1.0
in development mode. To make sure, that everything runs smooth, you need to run
your app server in production mode, where class reloading is disabled. You may
of course just use ChiliProject 2.1.
There is a bug in ChiliProject 2.0 which renders this plugin unusable.
If you are running into compatibility issues, please report a bug in the
project's issue tracker.
== Installation
Please follow the default plugin installation instructions for ChiliProject.
Make sure, the plugin folder is called `chiliproject_wiki_tabs`.
Also run
rake db:migrate:plugin NAME=chiliproject_wiki_tabs RAILS_ENV=production
to enable all changes that are needed database-wise.
== Update from versions before 5.0 to version 5.0 and later
Since we have renamed the recommended plugin name with version 5.0, there is
some mangeling with the migrations, when you making the update. Please follow
these steps to make it work.
1. Make a backup of your database.
2. Seriously, do a backup.
3. Execute the following SQL snippet on the database, you are using for your
ChiliProject
UPDATE schema_migrations
SET version = REPLACE(version, 'redmine_wiki_tabs', 'chiliproject_wiki_tabs');
You may do this, by using the commandline tools of your database vendor or by
starting a script/console from within the ChiliProject root folder
script/console production
> ActiveRecord::Base.connection.execute "UPDATE schema_migrations SET version = REPLACE(version, 'redmine_wiki_tabs', 'chiliproject_wiki_tabs');"
Be sure, that `redmine_wiki_tabs` was the old plugins directory name. Also make
sure, that you renamed it to `chiliproject_wiki_tabs`.
4. Execute the plugins migrations and make sure, that nothing happens.
== Screenshots
https://github.com/finnlabs/chiliproject_wiki_tabs/raw/master/doc/screen-capture-1.png
https://github.com/finnlabs/chiliproject_wiki_tabs/raw/master/doc/screen-capture-2.png
https://github.com/finnlabs/chiliproject_wiki_tabs/raw/master/doc/screen-capture-3.png
https://github.com/finnlabs/chiliproject_wiki_tabs/raw/master/doc/screen-capture-4.png
== Deinstallation
Run the down-migrations by executing
rake db:migrate:plugin NAME=chiliproject_wiki_tabs VERSION=0 RAILS_ENV=production
Remove the Plugin from vendor/plugins
rm -r vendor/plugins/chiliproject_wiki_tabs
== Development
To run the tests, you will need a current version of our {ChiliProject Dev
Tools}[https://github.com/finnlabs/redmine-dev-tools]. After running
bundle install
You should be able to execute the tests with
rake redmine:rspec:wiki_tabs
If these instructions are insufficient, please open a ticket in the GitHub issue
tracker with information, where you are stuck.
== Credits
We would like to thank
* Deutsche Telekom AG (opensource@telekom.de) for project sponsorhip
* Birthe Russmeyer and Niels Lindenthal of finnlabs for their consulting and
project management
== License
(c) 2011 - Gregor Schmidt - Finn GmbH
This plugin is licensed under the GNU GPL v2. See COPYRIGHT.txt and GPL.txt for
details.