Skip to content

Commit

Permalink
updating Bauble→Ghini in ghini-1.0-dev
Browse files Browse the repository at this point in the history
  • Loading branch information
mfrasca committed May 22, 2017
1 parent 204fed4 commit 5287ed4
Show file tree
Hide file tree
Showing 14 changed files with 111 additions and 109 deletions.
14 changes: 7 additions & 7 deletions doc/administration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,24 @@ your backup options starts at `chapter_24`_.
.. _chapter_24: http://www.postgresql.org/docs/9.1/static/backup.html
Bauble Configuration
Ghini Configuration
----------------------
Bauble uses a configuration file to store values across invocations. This
Ghini uses a configuration file to store values across invocations. This
file is associated to a user account and every user will have their own
configuration file.
To review the content of the Bauble configuration file, type ``:prefs`` in
To review the content of the Ghini configuration file, type ``:prefs`` in
the text entry area where you normally type your searches, then hit enter.

You normally do not need tweaking the configuration file, but you can do so
with a normal text editor program. Bauble configuration file is at the
with a normal text editor program. Ghini configuration file is at the
default location for SQLite databases.

Reporting Errors
----------------------

Should you notice anything unexpected in Bauble's behaviour, please consider
filing an issue on the Bauble development site.
Should you notice anything unexpected in Ghini's behaviour, please consider
filing an issue on the Ghini development site.

Bauble development site can be accessed via the Help menu.
Ghini development site can be accessed via the Help menu.
4 changes: 2 additions & 2 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ API Documentation
.. autodata:: bauble.db.Base
.. py:data:: bauble.db.Base
All tables/mappers in Bauble which use the SQLAlchemy declarative
All tables/mappers in Ghini which use the SQLAlchemy declarative
plugin for declaring tables and mappers should derive from this
class.

Expand All @@ -30,7 +30,7 @@ API Documentation
.. autoattribute:: bauble.db.metadata
.. py:data:: bauble.db.metadata
The default metadata for all Bauble tables.
The default metadata for all Ghini tables.

An instance of :class:`sqlalchemy.schema.MetaData`

Expand Down
6 changes: 3 additions & 3 deletions doc/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ Developer's Manual
helping bauble development
--------------------------

Installing Bauble always includes downloading the sources, connected to the
Installing Ghini always includes downloading the sources, connected to the
github repository. This is so because in our eyes, every user is always
potentially also a developer.

If you want to contribute to Bauble, you can do so in quite a few different ways:
If you want to contribute to Ghini, you can do so in quite a few different ways:

* use the software, note the things you don't like, open issue for each of them. a developer will react.
* if you have an idea of what you miss in the software but can't quite
formalize it into separate issues, you could consider hiring a
professional. this is the best way to make sure that something happens
quickly on Bauble. do make sure the developer opens issues and publishes
quickly on Ghini. do make sure the developer opens issues and publishes
their contribution on github.
* translate! any help with translations will be welcome, so please do! you
can do this without installing anything on your computer, just using the
Expand Down
26 changes: 13 additions & 13 deletions doc/devdl.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Downloading the source
======================

The Bauble source can be downloaded from our source
repository on `github <http://github.com/Bauble/bauble.classic>`_.
The Ghini source can be downloaded from our source
repository on `github <http://github.com/Ghini/ghini.desktop>`_.

If you want a particular version of Bauble, we release and maintain versions
If you want a particular version of Ghini, we release and maintain versions
into branches. You should ``git checkout`` the branch corresponding to the
version of your choice. Branch names for Bauble versions are of the form
version of your choice. Branch names for Ghini versions are of the form
``bauble-x.y``, where x.y can be 1.0, for example. Our workflow is to commit
to the `master` development branch or to a `patch` branch and to include the
commits into a `release` branch when ready.
Expand All @@ -16,13 +16,13 @@ to install the `Git <http://www.git.org>`_ version control system. Git is
incuded in all reasonable Linux distributions and can be installed on all
current operating systems.

Once you have installed Git you can checkout the latest Bauble code with
Once you have installed Git you can checkout the latest Ghini code with
the following command::

git clone https://github.com/Bauble/bauble.classic.git
git clone https://github.com/Ghini/ghini.desktop.git

For more information about other available code branches go to
`bauble.classic on github <http://www.github.com/Bauble/bauble.classic>`_.
`ghini.desktop on github <http://www.github.com/Ghini/ghini.desktop>`_.


Development Workflow
Expand Down Expand Up @@ -69,7 +69,7 @@ when ready for publication, merge master into the production line.
Adding missing unit tests
====================================

If you are interested contributing to development of Bauble, a good way to
If you are interested contributing to development of Ghini, a good way to
do so would be by helping us finding and writing the missing unit tests.

A well tested function is one whose behaviour you cannot change without
Expand Down Expand Up @@ -314,11 +314,11 @@ And at the end of the process you want to update the statistics::
Plugins structure
=============================

Bauble is a framework for handling collections, and is distributed along
with a set of plugins making Bauble a botanical collection manager. But
Bauble stays a framework and you could in theory remove all plugins we
Ghini is a framework for handling collections, and is distributed along
with a set of plugins making Ghini a botanical collection manager. But
Ghini stays a framework and you could in theory remove all plugins we
distribute and write your own, or write your own plugins that extend or
complete the current Bauble behaviour.
complete the current Ghini behaviour.

Once you have selected and opened a database connection, you land in the
Search window. The Search window is an interaction between two objects:
Expand All @@ -332,7 +332,7 @@ The search results shown in the largest part of SV are rows, objects that
are instances of classes registered in a plugin.

Each of these classes must implement an amount of functions in order to
properly behave within the Bauble framework. The Bauble framework reserves
properly behave within the Ghini framework. The Ghini framework reserves
space to pluggable classes.

SP knows of all registered (plugged in) classes, they are stored in a
Expand Down
12 changes: 6 additions & 6 deletions doc/editing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Editing and Inserting Data
==========================

The main way that we add or change information in Bauble is by using
The main way that we add or change information in Ghini is by using
the editors. Each basic type of data has its own editor. For example
there is a Family editor, a Genus editor, an Accession editor, etc.

Expand All @@ -24,7 +24,7 @@ on a Family and selecting "Add genus".

Notes
-----
Almost all of the editors in Bauble have a *Notes* tab which should work
Almost all of the editors in Ghini have a *Notes* tab which should work
the same regardless of which editor you are using.

If you enter a web address in a note then the link will show up in the
Expand Down Expand Up @@ -127,7 +127,7 @@ Accessions
----------

The Accession editor allows us to add an accession to a species. In
Bauble an accession represents a group of plants or clones. The
Ghini an accession represents a group of plants or clones. The
accession would refer maybe a group of seed or cuttings from a
species. A plant would be an individual from that accesssion, i.e. a
specific plant in a specific location.
Expand Down Expand Up @@ -173,7 +173,7 @@ plants that are created.
Pictures
^^^^^^^^

Just as almost all objects in the Bauble database can have *Notes*
Just as almost all objects in the Ghini database can have *Notes*
associated to them, Plants can have *Pictures*: next to the tab for Notes,
the Plants editor contains an extra tab called "Pictures". You can associate
as many pictures as you might need to a plant.
Expand All @@ -182,9 +182,9 @@ When you associate a picture to a plant, the file is copied in the
*pictures* folder, and a miniature (500x500) is generated and copied in the
`thumbnails` folder inside of the pictures folder.

As of Bauble-1.0.41, Pictures are not kept in the database. To ensure
As of Ghini-1.0.62, Pictures are not kept in the database. To ensure
pictures are available on all terminals where you have installed and
configured Bauble, you can use a file sharing service like Copy or
configured Ghini, you can use a file sharing service like Copy or
Dropbox. The personal choice of the writer of this document is to use Copy,
because it offers much more space and because of its "Fair Storage" policy.

Expand Down
4 changes: 2 additions & 2 deletions doc/extending.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Extending Bauble with Plugins
Extending Ghini with Plugins
-----------------------------

Nearly everything about Bauble is extensible through plugins. Plugins
Nearly everything about Ghini is extensible through plugins. Plugins
can create tables, define custom searchs, add menu items, create
custom commands and more.

Expand Down
18 changes: 9 additions & 9 deletions doc/imex.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Importing and Exporting Data
============================

Although Bauble can be extended through plugins to support alternate
Although Ghini can be extended through plugins to support alternate
import and export formats, by default it can only import and export
comma seperated values files or CSV.

Expand All @@ -18,11 +18,11 @@ Exporting ABCD and XML will not be covered here.

Importing from CSV
------------------
In general it is best to only import CSV files into Bauble that were
previously exported from Bauble. It is possible to import any CSV file
In general it is best to only import CSV files into Ghini that were
previously exported from Ghini. It is possible to import any CSV file
but that is more advanced that this doc will cover.

To import CSV files into Bauble select
To import CSV files into Ghini select
:menuselection:`Tools-->Export-->Comma Seperated Values` from the
menu.

Expand All @@ -34,11 +34,11 @@ files you want to import.
Exporting to CSV
----------------

To export the Bauble data to CSV select
To export the Ghini data to CSV select
:menuselection:`Tools-->Export-->Comma Seperated Values` from the menu.

This tool will ask you to select a directory to export the CSV data.
All of the tables in Bauble will be exported to files in the format
All of the tables in Ghini will be exported to files in the format
tablename.txt where tablename is the name of the table where the data
was exported from.

Expand All @@ -47,13 +47,13 @@ Importing from JSON

This is *the* way to import data into an existing database, without
destroying previous content. A typical example of this functionality would
be importing your digital collection into a fresh, just initialized Bauble
be importing your digital collection into a fresh, just initialized Ghini
database. Converting a database into bauble json interchange format is
beyond the scope of this manual, please contact one of the authors if you
need any further help.

Using the Bauble json interchange format, you can import data which you have
exported from a different Bauble installation.
Using the Ghini json interchange format, you can import data which you have
exported from a different Ghini installation.

Exporting to JSON
-----------------
Expand Down
18 changes: 9 additions & 9 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Documentation for Bauble 1.0
Documentation for Ghini 1.0
############################

.. image:: https://travis-ci.org/Bauble/bauble.classic.svg?branch=bauble-1.0
.. image:: https://travis-ci.org/Ghini/ghini.desktop.svg?branch=bauble-1.0
.. image:: https://hosted.weblate.org/widgets/bauble/-/svg-badge.svg
.. image:: https://coveralls.io/repos/Bauble/bauble.classic/badge.svg?branch=master&service=github :target: https://coveralls.io/github/Bauble/bauble.classic?branch=master
.. image:: https://coveralls.io/repos/Ghini/ghini.desktop/badge.svg?branch=master&service=github :target: https://coveralls.io/github/Ghini/ghini.desktop?branch=master

Bauble is an application for managing botanical specimen collections.
Ghini is an application for managing botanical specimen collections.
With it you can create a searchable database of plant records.

It is `open <http://www.opensource.org>`_ and `free <http://www.fsf.org>`_
Expand All @@ -22,7 +22,7 @@ Statements
peptalk
statements

Installing Bauble
Installing Ghini
=================

.. toctree::
Expand All @@ -31,7 +31,7 @@ Installing Bauble
installing


Using Bauble
Using Ghini
============

.. toctree::
Expand All @@ -56,7 +56,7 @@ Administration
administration


Bauble Development
Ghini Development
==================

.. toctree::
Expand All @@ -67,12 +67,12 @@ Bauble Development
extending
api

Supporting Bauble
Supporting Ghini
=================

.. image:: https://pledgie.com/campaigns/29188.png

If you're using Bauble, or if you feel like helping its development anyway,
If you're using Ghini, or if you feel like helping its development anyway,
please consider `donating <https://pledgie.com/campaigns/29188>`_


Expand Down

0 comments on commit 5287ed4

Please sign in to comment.