[commits] [Wiki] changed: CreatingYourFirstModule
Jan Schneider
jan at horde.org
Tue Oct 3 15:20:16 UTC 2017
jan Tue, 03 Oct 2017 15:20:16 +0000
Modified page: https://wiki.horde.org/CreatingYourFirstModule
New Revision: 23
Change log: Update links etc
@@ -3,32 +3,32 @@
+ Creating a Horde Module
Please follow the instructions below and choose the version for
which you'd like to start a new module. Once you have your first
module you need to populate it with content. This will be the subject
of the next section: PopulatingYourFirstModule
-++ Horde 5
+++ Horde 5+
-1. Check out the master git branch (instructions below).
+1. Check out the skeleton module:
<code type="sh">
- git clone --depth 1 git://github.com/horde/horde.git
- cd horde
+ git clone --depth 1 https://github.com/horde/skeleton.git
+ cd skelton
</code>
2. Start a new module - based on the Skeleton module - by running
the following helper script:
<code type="sh">
-./framework/bin/horde-generate-module newmodulename "Me Myself
<me at myselfandi.com>"
+./bin/skeleton-generate-module newmodulename "Me Myself <me at myselfandi.com>"
</code>
-The new module will end up in the git repository and have the name
"newmodulename".
+The new module will end up in skeleton's parent directory and have
the name "newmodulename".
3. Link or copy the new module into your horde installation.
<code type="sh">
- ln -s `pwd`/newmodulename /your/install/path/to/horde/
+ ln -s `pwd`/../newmodulename /your/install/path/to/horde/
</code>
-Linking is the preferred variant as this allows you to work within
the horde git repository and commit any code you write to a local
branch. At the same time you have the installation ready for immediate
testing of any changes.
+Linking is the preferred variant as this allows you to work within
the git repository and commit any code you write to a local branch. At
the same time you have the installation ready for immediate testing of
any changes.
4. In /path/to/horde/config/registry.d/ create a file called
newmodulename.php. Please note the documentation for available module
entry options in horde/config/registry.php, especially the menu
parent. If you want your module to go **anywhere else** in the menue,
you will need to change this!
This is a "registry.d" example for Horde 5:
@@ -49,12 +49,14 @@
</code>
This one is an example PNG from the basic horde application
-https://github.com/horde/horde/blob/master/horde/themes/default/graphics/horde.png
+https://github.com/horde/horde/raw/master/horde/themes/default/graphics/horde.png
++ Horde 4
+
+It is not recommended to use the Horde 4 Skeleton any longer.
1. Check out the skeleton module from horde git
<code type="sh">
More information about the commits
mailing list