This document will outline the standard process for creating MindTouch packages which ship with the default installations.
MindTouch devs.
Documented by RoyK
Upon any new installation, MindTouch packages will automatically deploy that mirror those in SVN at last code freeze.
Upon update, MindTouch packages will automatically deploy that mirror those in SVN at last code freeze, with the exception of hierarchies that are flagged as "editable" - particularly those in the IDF/pages hierarchy.
Here is a rough outline of how the packages are created from the SVN tree:
Base SVN tree is: https://svn.mindtouch.com/source/pri...kiwiki/library
| Package Name | Permissions | Package Description | Capability | Capability (Commercial-type) | Other Flags | Hierarchies Covered |
|---|---|---|---|---|---|---|
| 0010-mindtouch-templates.mtapp | Public | This is core library of MindTouch templates which are used on every install | N/A | N/A |
| |
| 0010-mindtouch-special-reports.mtapp | Private | These are the curation analytics reports, available on every install | N/A | N/A |
| |
| 0020-mindtouch-templates-idf.mtapp | Public | These are the IDF templates, excluding the pages. | package-idf | N/A |
| |
| 0030-mindtouch-templates-idf-pages.mtapp | Public | These are the IDF pages. (These are a separate package because IDF pages are editable by the end-user and are not to be overwritten upon updates) | package-idf | N/A |
| |
| 0040-mindtouch-imm.mtapp | Public | The IMM modules | package-imm | N/A |
| |
| 0050-mindtouch-oobe-none.mtapp | Public | OOBE for the core install | N/A | none | initonly importonce |
|
| 0050-mindtouch-oobe-commercial.mtapp | Public | OOBE for the commercial product | N/A | commercial | initonly importonce |
|
| 0050-mindtouch-oobe-platform.mtapp | Public | OOBE for the platform | N/A | platform | initonly importonce | (same as core) |
| 0060-mindtouch-oobe-none-homepage.mtapp | Public | Core OOBE homepage insertion | N/A | none | initonly importonce | Inserts content from Template:MindTouch/OOBE/Core/Home to the root Main: page |
| 0060-mindtouch-oobe-commercial-homepage.mtapp | Public | Commercial OOBE homepage insertion | N/A | commercial | initonly importonce | Inserts content from Template:MindTouch/OOBE/Commercial/Home to the root Main: page |
| 0060-mindtouch-oobe-platform-homepage.mtapp | Public | Platform OOBE homepage insertion | N/A | platform | initonly importonce | Inserts content fromTemplate:MindTouch/OOBE/Core/Home to the root Main: page |
| 0065-mindtouch-oobe-idf.mtapp | Public | Sample IDF Pages | package-idf | N/A | initonly importonce | Inserts content from /Acme_Jetpack_User_Guide |
These are the command line tools I run to create all the packages. They reference loose files ("mindtouch-templates") which are files with absolute URLs (one per line) of the targeted template tree (as outlined in the table above under "hierarchies covered").
mono mindtouch.import.exe -U "admin" -P "password" -h "TARGET-MINDTOUCH-INSTALL" -e -L mindtouch-templates -r -O ../packages/default/public/0010-mindtouch-templates.mtapp; mono mindtouch.import.exe -U "admin" -P "password" -h "TARGET-MINDTOUCH-INSTALL" -e -L mindtouch-special-reports -r -O ../packages/default/private/0010-mindtouch-special-reports.mtapp; mono mindtouch.import.exe -U "admin" -P "password" -h "TARGET-MINDTOUCH-INSTALL" -e -L mindtouch-templates-ckb -r -O -cap package-idf ../packages/default/public/0020-mindtouch-templates-idf.mtapp; mono mindtouch.import.exe -U "admin" -P "password" -h "TARGET-MINDTOUCH-INSTALL" -e -L mindtouch-templates-ckb-pages -r -l -cap package-idf ../packages/default/public/0030-mindtouch-templates-idf-pages.mtapp; mono mindtouch.import.exe -U "admin" -P "password" -h "TARGET-MINDTOUCH-INSTALL" -e -L mindtouch-imm -r -O -cap package-imm ../packages/default/public/0040-mindtouch-imm.mtapp;
All steps assume you've checked out the base svn library, above.
To create new packages (.mtapp files):
To update loose XML files in svn:
Sample Scenario: Update default templates with new content
To copy pages to another server
Sample Scenario: Give Product Management a safe area to edit the OOBE experience
Note: The .mtapp files are zips, and can be extracted with "7za e package.mtapp" (apt-get install p7zip-full if 7za is not installed). For some reason, the packages do not open on Mac -- use Windows and Izarc (for example) to edit the contents of the package.
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
Copyright © 2011 MindTouch, Inc. Powered by