Explain relative naming policies necessary to allow varying the package

name without breaking operation.

1 files changed, 13 insertions, 0 deletions

diff --git a/docs/tutorials/wiki/NOTE-relocatable.txt b/docs/tutorials/wiki/NOTE-relocatable.txt
new file mode 100644
index 000000000..7e42cf573
--- /dev/null
+++ b/docs/tutorials/wiki/NOTE-relocatable.txt
@@ -0,0 +1,13 @@
+We specifically use relative package references where possible so this demo
+works even if the user names their package (in the 'bin/paster create -t
+pyramid_zodb ...' step) something other than 'tutorial'.
+
+Specifically:
+
+- use relative imports
+- use plain relative URLs for resources (like stylesheets and images) in
+  page templates.
+
+Direct uses of the package name, like in __init__.py 'config.scan()'
+statements, are already adjusted by the paster/pcreate, so we don't have to
+worry about them.