Module Development Collaboration - Revision history

David Haslam: /* Makefile */ spaces inserted for alignment

2015-12-18T12:57:30Z

‎Makefile: spaces inserted for alignment

2015-12-18T12:55:50Z

‎metadata: [http://en.wikipedia.org/wiki/Dublin_Core Dublin Core]

2015-12-17T20:43:09Z

‎Directory structure: removed "|" which caused the 404 error.

2015-08-31T12:25:02Z

2015-08-30T08:16:36Z

‎Version control

2015-08-30T08:01:32Z

‎Makefile

2015-08-30T08:00:40Z

‎Makefile

2015-08-30T07:58:28Z

‎Directory structure

2015-08-30T07:58:16Z

‎Directory structure

2015-08-30T07:57:40Z

‎Directory structure

@@ Line 52: / Line 52: @@
 The makefile templates we offer run usually following
-  make clean     (delete all intermediate format files)
+  make clean       (delete all intermediate format files)
-  make deepclean (resets everything back to the first step, deleting work directories, intermediate files etc.)
+  make deepclean   (resets everything back to the first step, deleting work directories, intermediate files etc.)
-  make setup     (sets up a working environment with relevant directories, pulls in files, scripts etc)
+  make setup       (sets up a working environment with relevant directories, pulls in files, scripts etc)
-  make all       (create a finalised module ready for publication)
+  make all         (create a finalised module ready for publication)
-  make tests     (run various tests on the files you have produced to find inconsistencies)
+  make tests       (run various tests on the files you have produced to find inconsistencies)
   make publish     (push the finalised module out to a staging area and deploy in a repository)
   make localdeploy (copy the finalised module into your own Sword installation to allow easy testing with your own CrossWire biblestudy programmes)

@@ Line 62: / Line 62: @@
 ==== metadata ====
-Metadata should be collated into a single file (maybe something XML to facilitate validation for automated generation & parsing) the incorporates all necessary metadata for all of our output formats (OSIS, ThML, TEI, EPUB/MOBI, Sword). Investigate Dublin Core & other metadata standards. Consider developing a set of private-use extensions to an existing standard and consistent methods of encoding all of our relevant .conf values in OSIS/ThML/TEI files.
+Metadata should be collated into a single file (maybe something XML to facilitate validation for automated generation & parsing) the incorporates all necessary metadata for all of our output formats (OSIS, ThML, TEI, EPUB/MOBI, Sword). Investigate [http://en.wikipedia.org/wiki/Dublin_Core Dublin Core] & other metadata standards. Consider developing a set of private-use extensions to an existing standard and consistent methods of encoding all of our relevant .conf values in OSIS/ThML/TEI files.
 [[Category:Development tools]]
 [[Category:Documentation]]
 [[Category:Modules]]

@@ Line 13: / Line 13: @@
 == Directory structure ==
-Our [https://github.com/refdoc/Module-tools| Github] repository provides makefiles and scripts to setup a module making environment:
+Our [https://github.com/refdoc/Module-tools Github] repository provides makefiles and scripts to setup a module making environment:
 At the root is a bunch of makefile templates. Choose the appropriate, amend it as necessary and rename it "Makefile" and run

@@ Line 3: / Line 3: @@
 CrossWire will provide to module teams who want to collaborate on a module following tools:
-# A private Git repository - access will be via SSH keys which can act as a scrapbook and collaboration tool
+# A private Git repository (access will be via SSH keys) which can act as a scrapbook and collaboration tool
 # Email notification system - all changes to the repository are automatically notified to all collaborators
 # Some templates for the repository and a bunch of scripts to make module making easy.

← Older revision		Revision as of 08:16, 30 August 2015
Line 8:		Line 8:

	If you want to get such a repository on the CrossWire server please email to ''modules'' AT ''crosswire'' DOT ''org''.		If you want to get such a repository on the CrossWire server please email to ''modules'' AT ''crosswire'' DOT ''org''.
		+
		+	CrossWire itself uses a similar setup for its internal development and for the automatic (re)deployment of modules.

	== Directory structure ==		== Directory structure ==

@@ Line 11: / Line 11: @@
 == Directory structure ==
-The [https://github.com/refdoc/Module-tools|Module-tools on Github] repository provides makefiles and scripts to setup a module making environment:
+Our [https://github.com/refdoc/Module-tools|Github] repository provides makefiles and scripts to setup a module making environment:
 At the root is a bunch of makefile templates. Choose the appropriate, amend it as necessary and rename it "Makefile" and run