--- a/doc/book/en/tutorials/advanced/part03_bfss.rst Tue Mar 15 10:38:02 2011 +0100
+++ b/doc/book/en/tutorials/advanced/part03_bfss.rst Tue Mar 15 21:36:06 2011 +0100
@@ -23,20 +23,20 @@
from cubicweb.server.sources import storage
class ServerStartupHook(hook.Hook):
- __regid__ = 'sytweb.serverstartup'
- events = ('server_startup', 'server_maintenance')
+ __regid__ = 'sytweb.serverstartup'
+ events = ('server_startup', 'server_maintenance')
- def __call__(self):
- bfssdir = join(self.repo.config.appdatahome, 'bfss')
- if not exists(bfssdir):
- makedirs(bfssdir)
- print 'created', bfssdir
- storage = storages.BytesFileSystemStorage(bfssdir)
- set_attribute_storage(self.repo, 'File', 'data', storage)
+ def __call__(self):
+ bfssdir = join(self.repo.config.appdatahome, 'bfss')
+ if not exists(bfssdir):
+ makedirs(bfssdir)
+ print 'created', bfssdir
+ storage = storages.BytesFileSystemStorage(bfssdir)
+ set_attribute_storage(self.repo, 'File', 'data', storage)
.. Note::
- * how we built the hook's registry identifier (_`_regid__`): you can introduce
+ * how we built the hook's registry identifier (`__regid__`): you can introduce
'namespaces' by using there python module like naming identifiers. This is
especially import for hooks where you usually want a new custom hook, not
overriding / specializing an existant one, but the concept may be applied to
@@ -50,48 +50,48 @@
* the path given to the storage is the place where file added through the ui
(or in the database before migration) will be located
- * be ware that by doing this, you can't anymore write queries that will try to
+ * beware that by doing this, you can't anymore write queries that will try to
restrict on File `data` attribute. Hopefuly we don't do that usually
on file's content or more generally on attributes for the Bytes type
Now, if you've already added some photos through the web ui, you'll have to
migrate existing data so file's content will be stored on the file-system instead
of the database. There is a migration command to do so, let's run it in the
-cubicweb shell (in actual life, you'd have to put it in a migration script as we
-seen last time):
+cubicweb shell (in real life, you would have to put it in a migration script as we
+have seen last time):
::
$ cubicweb-ctl shell sytweb
- entering the migration python shell
- just type migration commands or arbitrary python code and type ENTER to execute it
- type "exit" or Ctrl-D to quit the shell and resume operation
- >>> storage_changed('File', 'data')
- [........................]
+ entering the migration python shell
+ just type migration commands or arbitrary python code and type ENTER to execute it
+ type "exit" or Ctrl-D to quit the shell and resume operation
+ >>> storage_changed('File', 'data')
+ [........................]
-That's it. Now, file added through the web ui will have their content stored on
+That's it. Now, files added through the web ui will have their content stored on
the file-system, and you'll also be able to import files from the file-system as
explained in the next part.
Step 2: importing some data into the instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Hey, we start to have some nice features, let give us a try on this new web
+Hey, we start to have some nice features, let us give a try to this new web
site. For instance if I have a 'photos/201005WePyrenees' containing pictures for
a particular event, I can import it to my web site by typing ::
$ cubicweb-ctl fsimport -F sytweb photos/201005WePyrenees/
** importing directory /home/syt/photos/201005WePyrenees
- importing IMG_8314.JPG
- importing IMG_8274.JPG
- importing IMG_8286.JPG
- importing IMG_8308.JPG
- importing IMG_8304.JPG
+ importing IMG_8314.JPG
+ importing IMG_8274.JPG
+ importing IMG_8286.JPG
+ importing IMG_8308.JPG
+ importing IMG_8304.JPG
.. Note::
- The -F option tell that folders should be mapped, hence my photos will be
- all under a Folder entity corresponding to the file-system folder.
+ The -F option means that folders should be mapped, hence my photos will be
+ linked to a Folder entity corresponding to the file-system folder.
Let's take a look at the web ui:
@@ -103,11 +103,11 @@
.. image:: ../../images/tutos-photowebsite_ui2.png
-Yeah, it's there! You can also notice that I can see some entities as well as
+Yeah, it's there! You will notice that I can see some entities as well as
folders and images the anonymous user can't. It just works **everywhere in the
ui** since it's handled at the repository level, thanks to our security model.
-Now if I click on the newly inserted folder, I can see
+Now if I click on the recently inserted folder, I can see
.. image:: ../../images/tutos-photowebsite_ui3.png
@@ -124,7 +124,7 @@
We started to see here an advanced feature of our repository: the ability
to store some parts of our data-model into a custom storage, outside the
database. There is currently only the :class:`BytesFileSystemStorage` available,
-but you can expect to see more coming in a near future (our write your own!).
+but you can expect to see more coming in a near future (or write your own!).
Also, we can know start to feed our web-site with some nice pictures!
The site isn't perfect (far from it actually) but it's usable, and we can