I only looked at the .DOC so far, and that seems like a decent start. If I was fleshing it out I would definitely write each step more verbosely (I'm guessing that's part of what you were talking about when you refer to the 1/3-1/10). Maybe the CwModuleTutorial includes the information, but I would envision the module-making guide containing information specific to the individual mark-ups. I found that there were two main caveats in the current module guide: 1) it didn't give much information on the markups, some of which seemed to be rather esoteric in my opinion, and 2) once it moved past the mark-up, it didn't give much indication of the output files of the different conversion utilities.
<br><br>So I envision a module-making guide that contains the following steps:<br>1) A discussion of SWORD in general<br>2) A discussion of the different types of texts: Bible, Commentary, Lexicon, General Book as well as the derivatives and how they are implemented, such as the daily devotionals.
<br>3) A discussion of the main types of markups with more than just a link to the describing organization. It was difficult to identify that ThML didn't really work with Bibles while OSIS is sometimes overkill for something simple.
<br>4) Work through how to prepare the document and discuss the module configuration file.<br>5) Discuss the different import utilities and what their disparate outputs are for. At first I was very confused when a bible spat out 4 files but a General Book resulted in 3 very different files.
<br>6) Indicate how the files are to be stored within the preferred directory structure for Sword. Especially note that the configuration file for a General Book must contain the first part of the filename in its path argument whereas the Bibles do not contain that information.
<br><br>I got the feeling that my basic outline has much in common with your list, but I guess I was looking to combine documentation with a how-to/tutorial because I always find that the easiest and most efficient method of learning is to follow an example that also explains how and why everything is happening.
<br><br>--Greg<br><br><div><span class="gmail_quote">On 2/8/06, <b class="gmail_sendername">L.Allan-pbio</b> <<a href="mailto:paraclete@bibleinverse.org">paraclete@bibleinverse.org</a>> wrote:</span><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
Greg H. wrote:<br>> Due to some of the same difficulties you were running into, I had planned<br>> to make a new tutorial on how to create a module in my edits to the<br>> website. ...<br>> As for a prepared tutorial on the website... I'm not aware of one other
<br>> than the one you looked for. It needs some significant work to keep the<br>> prospective user from being over-worked to fill in the gaps, and I'd like<br>> to get to that soon, but there are other website changes I had planned to
<br>> work on for Troy first. Hopefully I'll get to tackle some of those<br>> soon-ish. Cheers!<br><br>I wrestled with mod2imp and the other converters, and sort of got them to<br>work. Thanks for your help.<br><br>
I thought it might be useful to draft the start of a tutorial while the<br>steps were relatively fresh in my mind. Perhaps we could combine efforts?<br><br>Here is a link to a first draft, with only about 1/3 to 1/10 of the eventual
<br>content ... if it seems worthwhile to continue ...<br><a href="http://lcdbible.sourceforge.net/misc/CwModuleTutorial.doc">http://lcdbible.sourceforge.net/misc/CwModuleTutorial.doc</a><br>which references a "StarterKit"
<br><a href="http://lcdbible.sourceforge.net/misc/CwModuleTutorial_060208c.zip">http://lcdbible.sourceforge.net/misc/CwModuleTutorial_060208c.zip</a><br><br>Feedback appreciated.<br><br>_______________________________________________
<br>sword-devel mailing list: <a href="mailto:sword-devel@crosswire.org">sword-devel@crosswire.org</a><br><a href="http://www.crosswire.org/mailman/listinfo/sword-devel">http://www.crosswire.org/mailman/listinfo/sword-devel
</a><br>Instructions to unsubscribe/change your settings at above page<br></blockquote></div><br>