From: Benny M. <ben...@gm...> - 2008-01-11 10:28:43
|
Great news! It suffices to change the man page. Concerning the manual, the xml will be generated in a yet to determine fashion for 3.0 from our wiki manual. So if you want to help out with the 3.0 manual, you should edit http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual Everything is allowed (new sections, ....) within the conventions (or add new conventions). At the moment I only know of Jerome (romjerome atte yahoo.fr ) and Erik ( frederik.de.richter atte googlemail.com ) working on it, but they are both non-English speakers, so we could use an English mothertongue to help out. If you would change the command line working of gramps, you need to edit http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Command_Line While writing it you mind find some bugs in the code, which you can list on our bug tracker. Benny. 2008/1/10, na...@no... <na...@no...>: > > Benny, > > I'm more than willing to make the changes to data/man/gramps.1.in > and help/C/gramps.xml > > I can make them consistent with the output of 'gramps --help' this > weekend. If you want more work done on them than that then it's obviously > going to take longer. > > I don't have write access to the svn repository but I guess I probably > don't need it - it might better if I e-mailed you or one of the other > developers the context diffs. > > Cedric > Benny Malengier wrote: > > > > Hi all, > > > > I would like to ask some help of a non-coder in the community. The task > is > > the following: rewrite the man pages for GRAMPS, and update the section > of > > the 3.0 manual on the command line usage of GRAMPS. The man pages are in > > svn: data/man/gramps.1.in > > > > I commited today changes to the argument handling of gramps, so CLI > works > > again. Some things have changed, that is why the man pages should be > > updated. I could not fully test all possible combinations though, but > the > > main ones should be functional again. > > In short, in 3.0, we allow (examples with gramps.py, after installation > > this > > will be of course just gramps): > > > > 1/-O, Open of a family tree. This can be done also by just typing the > name > > (name or database dir), > > example: > > python gramps.py 'Family Tree 1' > > python gramps.py /home/cristina/.gramps/grampsdb/47320f3d > > python gramps.py -O 'Family Tree 1' > > python gramps.py -O /home/cristina/.gramps/grampsdb/47320f3d > > > > So note that in keeping with the new philosophy, gramps can only open > it's > > native format. All the rest must be imported! > > > > 2/ -i, Import of any mime-type understood by an importer, optionally > > provide -f to indicate format (possible: > > 'gedcom','gramps-xml','gramps-pkg', 'grdb','geneweb'). A family tree can > > also be given > > If no open database, import in a temporary empty family tree > > example: > > python gramps.py -i 'Family Tree 1' -i 'Family Tree 2' > > python gramps.py -i test.grdb -i data.gramps > > > > 3/ -o, output a family tree in required format, optionally provide > > -f to indicate format (possible: 'gedcom', > > 'gramps-xml','gramps-pkg','iso','wft','geneweb'). It is not possible to > > export to a family tree. > > example: > > python gramps.py -i 'Family Tree 1' -i test.grdb -f grdb -o > > mergdeDB.gramps > > Note that above does not change 'Family Tree 1' as everything happens > via > > a > > temporary database, whereas: > > python gramps.py -O 'Family Tree 1' -i test.grdb -f grdb -o > > mergdeDB.gramps > > will import test.grdb into Family Tree 1, and then export to a file ! > > > > 4/ -l, print a list of known family trees > > > > 5/ -a, action. I have not touched this code, so remains the same. Known > > actions: 'check', 'summary' and 'report' and 'tool', where the last can > be > > used to run any report/tool of the plugins that has a CLI interface. > > > > 6/No argument, just a file. In the case of a known family tree, see 1/. > In > > the case of a file of which an importer is known, the same happens as in > > 2/ > > with the -i option, but instead of a temporary database, a new database > is > > made with as name the filename without the extension, and the file > > imported > > into it., after which the Gramps interface pops up on this database. The > > name can easily be changed in the family tree manager. > > example: > > python gramps.py 'Family Tree 1' > > python gramps.py data.gramps > > So this last line will create a family tree 'data' and import > > data.grampsinto it. > > > > If -o and/or -a is given, no GTK interface is shown, and all happens on > > the > > command line. In the other case, gramps opens with the database as > > requested > > > > All possible combinations have not been tested. Perhaps somebody has > time > > to > > try some things and post bugs? At least the main uses of the CLI should > > function again. > > > > As a sidenote, I fixed arghandler.py, should somebody have time, this > file > > can actually use a complete rewrite. It is not our best code at the > > moment. > > > > Benny > > > > > ------------------------------------------------------------------------- > > This SF.net email is sponsored by: Microsoft > > Defy all challenges. Microsoft(R) Visual Studio 2005. > > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > > _______________________________________________ > > Gramps-devel mailing list > > Gra...@li... > > https://lists.sourceforge.net/lists/listinfo/gramps-devel > > > > > Quoted from: http://www.nabble.com/help-needed-tp14527292p14527292.html > > |
From: <rom...@ya...> - 2008-01-23 19:30:30
|
I would like to try Wikimedia DTD to XML (SGML, docbook) on current wiki http://www.gramps-project.org/wiki/index.php?title=Manual_Generation_3.0#XML_to_XML But I do not what is possible. Duncan Lithgow a écrit : > Recently I can see that the decision has been made to not ship the > manual in further releases for the time being. I'm one of those who > thinks this is far from ideal and would like to talk a bit about our > options... > > The 'unstable' Manual: > * The current Online Wiki is looking nice, and I've been tempted to work > on it every now and then, but there is no imposed structure so I'm > concerned that it will quickly become a confusing mess if lots of people > try to simultaneously take it in different directions. Wiki software is > good for making documents quick and easy - but weak on structure. > ** An attempt at addressing this can be seen at the > http://en.wikibooks.org/wiki/Main_Page website. The section/pages of > each 'wikibook' there have a hierarchical relationship to each other. > This forces contributors of new content to always consider the > appropriate place for their content. > An example, simply because I organised it so I can answer questions > about it, is the http://en.wikibooks.org/wiki/Straw_Bale_Construction > wikibook. You'll notice the contents boxes easily added on each page and > the section which creates one large flat HTML or PDF file > http://en.wikibooks.org/wiki/Straw_Bale_Construction/Print_version > > Perhaps that system would offer some advantages? > > The (future) Stable Manual: > * A general _big_ gripe I have about electronic manuals generally is how > one-way they are. It is now so easy to have an link of some sort for > further clarifying or questions on each page of the manual that I really > don't understand why all manuals don't have one. > The best example I am aware of is the online manual at php.net > http://www.php.net/manual/en/index.php > I think pages like this one show how the comments can help clarify and > expand the manual: > http://www.php.net/manual/en/language.types.type-juggling.php#language.types.typecasting > When downloading the manual one can choose to include the user comments > or not. > > So, what's next. And yes I'll try and help edit the wiki manual. > > Duncan > > > ------------------------------------------------------------------------- > This SF.net email is sponsored by: Microsoft > Defy all challenges. Microsoft(R) Visual Studio 2008. > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > _______________________________________________ > Gramps-devel mailing list > Gra...@li... > https://lists.sourceforge.net/lists/listinfo/gramps-devel > |
From: Duncan L. <dli...@gm...> - 2008-01-23 19:12:59
|
Recently I can see that the decision has been made to not ship the manual in further releases for the time being. I'm one of those who thinks this is far from ideal and would like to talk a bit about our options... The 'unstable' Manual: * The current Online Wiki is looking nice, and I've been tempted to work on it every now and then, but there is no imposed structure so I'm concerned that it will quickly become a confusing mess if lots of people try to simultaneously take it in different directions. Wiki software is good for making documents quick and easy - but weak on structure. ** An attempt at addressing this can be seen at the http://en.wikibooks.org/wiki/Main_Page website. The section/pages of each 'wikibook' there have a hierarchical relationship to each other. This forces contributors of new content to always consider the appropriate place for their content. An example, simply because I organised it so I can answer questions about it, is the http://en.wikibooks.org/wiki/Straw_Bale_Construction wikibook. You'll notice the contents boxes easily added on each page and the section which creates one large flat HTML or PDF file http://en.wikibooks.org/wiki/Straw_Bale_Construction/Print_version Perhaps that system would offer some advantages? The (future) Stable Manual: * A general _big_ gripe I have about electronic manuals generally is how one-way they are. It is now so easy to have an link of some sort for further clarifying or questions on each page of the manual that I really don't understand why all manuals don't have one. The best example I am aware of is the online manual at php.net http://www.php.net/manual/en/index.php I think pages like this one show how the comments can help clarify and expand the manual: http://www.php.net/manual/en/language.types.type-juggling.php#language.types.typecasting When downloading the manual one can choose to include the user comments or not. So, what's next. And yes I'll try and help edit the wiki manual. Duncan |
From: Benny M. <ben...@gm...> - 2008-01-23 20:23:07
|
RXJpayBpcyB3cml0aW5nIGEgcHl0aG9uIHNjcmlwdCB0byBleHRyYWN0IHRoZSB3aWtpbWVkaWEg c3ludGF4IHRvIGh0bWwuClRoYXQgd291bGQgdGhlbiB3b3JrIGxvY2FsbHkKCkFueXdheSwgdGhl IHByZXZpb3VzIG1hbnVhbCB3YXMgbWFpbmx5IHdyaXR0ZW4gYnkgdGhlIG1haW4gZGV2ZWxvcGVy cywgYW5kCnRvZGF5J3MgZGV2ZWxvcGVycyBkbyBub3QgYXBwZWFyIHRvIGJlIHZlcnkgZG9jdW1l bnRhdGlvbiBvcmllbnRlZCwgYW5kIGEKbWVzc3kgZG9jdW1lbnRhdGlvbiBpcyBpbiBteSBib29r IHN0aWxsIGJldHRlciB0aGFuIG5vIGRvY3VtZW50YXRpb24uIE15CmV4cGVyaWVuY2UgaXMgdGhh dCBub24tZGV2ZWxvcGVycyBoYXZlIHByb2JsZW1zIHdpdGggdGhlIG9sZCBkb2Nib29rIHN0eWxl Cm9mIG1hbnVhbCBhbmQgYXJlIGRhdW50ZWQgdG8gc3RhcnQgcGF0Y2hpbmcvZWRpdGluZyB0aGF0 LiBUaGUgd2lraSBpcyB0aGVyZQp0byBnZXQgdGhvc2UgcGVvcGxlIGludm9sdmVkLiBJIHRoaW5r IHRoYXQgd29ya3MgYSBiaXQsIGJ1dCBvbmx5IG9uIHZlcnkKc3BlY2lmaWMgc3ViamVjdHMgYXQg dGhlIG1vbWVudC4KCkFzIEkgc2VlIGl0LCBpZiB0aGUgY29udGVudCBpcyB0aGVyZSwgYSBnb29k ICJlZGl0b3IvYWRtaW5pc3RyYXRvciIgY291bGQKcXVpY2tseSByZXdvcmsgaXQgdG8gYSBzdHJ1 Y3R1cmVkIGJvb2sgaW4gYSBjb3VwbGUgb2YgZGF5cy4gVGhlIHdpa2kgaXMKdGhlcmUgdG8gY3Jl YXRlIHRoYXQgY29udGVudCBpbiB0aGUgZmlyc3QgcGxhY2UuIExvb2tpbmcgYXQgdGhlIGVkaXQK aGlzdG9yeSwgbm90IG1hbnkgcGVvcGxlIGFyZSBoZWxwaW5nIG91dCBhdCB0aGUgbW9tZW50IHRo b3VnaC4KCkRvbiBhZ3JlZWQgaW4gdGhlIGJlZ2lubmluZyB0byB0aGlzIHNldHVwIHVuZGVyIHRo ZSBwcmV0ZXh0OiBpZiB0aGUgY29udGVudAppcyB0aGVyZSwgc29tZWJvZHkgY2FuIGRvIGEgZG9j Ym9vayBtYW51YWwgYmFzZWQgb24gdGhhdC4KTXkgaWRlYSB0byBzdGFydCBpdCB0aG91Z2ggd2Fz IHRvIGdldCBtb3JlIHBlb3BsZSBpbnZvbHZlZCBhbmQgdG8gYXZvaWQgYQpjb21wbGV0ZSBzdGFs ZSBkb2N1bWVudGF0aW9uLCB3aGljaCBpcyB3aGF0IHdlIHdvdWxkIGhhdmUgd2l0aCB0aGUgb2xk CmZvcm1hdC4gRm9yIG1lLCB0aGUgd2lraSBpcyBnb29kIGVub3VnaCBhcyBhIG1hbnVhbC4gSSB3 b24ndCBzdG9wIG90aGVycwpwdXR0aW5nIGVmZm9ydCBpbnRvIGEgZG9jYm9vayB0aG91Z2guCgpJ IGRvIHRoaW5rIHRoYXQgYmVmb3JlIHJlbGVhc2Ugb2YgMy4wLCB3ZSBoYXZlIHRvIGRvIGEgZG9j dW1lbnRhdGlvbiB3ZWVrOgpubyBjb21taXRzIGFsbG93ZWQsIGFuZCBldmVyeWJvZHkgbXVzdCBz aG93IGF0IGxlYXN0IDEwIHNhdmVzIG9uIG1hbnVhbCB0bwpyZXRhaW4gY29tbWl0IHJpZ2h0cyA7 LSkKCkJlbm55CgoyMDA4LzEvMjMsIErDqXLDtG1lIDxyb21qZXJvbWVAeWFob28uZnI+Ogo+Cj4g SSB3b3VsZCBsaWtlIHRvIHRyeSBXaWtpbWVkaWEgRFREIHRvIFhNTCAoU0dNTCwgZG9jYm9vaykg b24gY3VycmVudCB3aWtpCj4KPiBodHRwOi8vd3d3LmdyYW1wcy1wcm9qZWN0Lm9yZy93aWtpL2lu ZGV4LnBocD90aXRsZT1NYW51YWxfR2VuZXJhdGlvbl8zLjAjWE1MX3RvX1hNTAo+Cj4gQnV0IEkg ZG8gbm90IHdoYXQgaXMgcG9zc2libGUuCj4KPgo+IER1bmNhbiBMaXRoZ293IGEgw6ljcml0IDoK PiA+IFJlY2VudGx5IEkgY2FuIHNlZSB0aGF0IHRoZSBkZWNpc2lvbiBoYXMgYmVlbiBtYWRlIHRv IG5vdCBzaGlwIHRoZQo+ID4gbWFudWFsIGluIGZ1cnRoZXIgcmVsZWFzZXMgZm9yIHRoZSB0aW1l IGJlaW5nLiBJJ20gb25lIG9mIHRob3NlIHdobwo+ID4gdGhpbmtzIHRoaXMgaXMgZmFyIGZyb20g aWRlYWwgYW5kIHdvdWxkIGxpa2UgdG8gdGFsayBhIGJpdCBhYm91dCBvdXIKPiA+IG9wdGlvbnMu Li4KPiA+Cj4gPiBUaGUgJ3Vuc3RhYmxlJyBNYW51YWw6Cj4gPiAqIFRoZSBjdXJyZW50IE9ubGlu ZSBXaWtpIGlzIGxvb2tpbmcgbmljZSwgYW5kIEkndmUgYmVlbiB0ZW1wdGVkIHRvIHdvcmsKPiA+ IG9uIGl0IGV2ZXJ5IG5vdyBhbmQgdGhlbiwgYnV0IHRoZXJlIGlzIG5vIGltcG9zZWQgc3RydWN0 dXJlIHNvIEknbQo+ID4gY29uY2VybmVkIHRoYXQgaXQgd2lsbCBxdWlja2x5IGJlY29tZSBhIGNv bmZ1c2luZyBtZXNzIGlmIGxvdHMgb2YgcGVvcGxlCj4gPiB0cnkgdG8gc2ltdWx0YW5lb3VzbHkg dGFrZSBpdCBpbiBkaWZmZXJlbnQgZGlyZWN0aW9ucy4gV2lraSBzb2Z0d2FyZSBpcwo+ID4gZ29v ZCBmb3IgbWFraW5nIGRvY3VtZW50cyBxdWljayBhbmQgZWFzeSAtIGJ1dCB3ZWFrIG9uIHN0cnVj dHVyZS4KPiA+ICoqIEFuIGF0dGVtcHQgYXQgYWRkcmVzc2luZyB0aGlzIGNhbiBiZSBzZWVuIGF0 IHRoZQo+ID4gaHR0cDovL2VuLndpa2lib29rcy5vcmcvd2lraS9NYWluX1BhZ2Ugd2Vic2l0ZS4g VGhlIHNlY3Rpb24vcGFnZXMgb2YKPiA+IGVhY2ggJ3dpa2lib29rJyB0aGVyZSBoYXZlIGEgaGll cmFyY2hpY2FsIHJlbGF0aW9uc2hpcCB0byBlYWNoIG90aGVyLgo+ID4gVGhpcyBmb3JjZXMgY29u dHJpYnV0b3JzIG9mIG5ldyBjb250ZW50IHRvIGFsd2F5cyBjb25zaWRlciB0aGUKPiA+IGFwcHJv cHJpYXRlIHBsYWNlIGZvciB0aGVpciBjb250ZW50Lgo+ID4gQW4gZXhhbXBsZSwgc2ltcGx5IGJl Y2F1c2UgSSBvcmdhbmlzZWQgaXQgc28gSSBjYW4gYW5zd2VyIHF1ZXN0aW9ucwo+ID4gYWJvdXQg aXQsIGlzIHRoZSBodHRwOi8vZW4ud2lraWJvb2tzLm9yZy93aWtpL1N0cmF3X0JhbGVfQ29uc3Ry dWN0aW9uCj4gPiB3aWtpYm9vay4gWW91J2xsIG5vdGljZSB0aGUgY29udGVudHMgYm94ZXMgZWFz aWx5IGFkZGVkIG9uIGVhY2ggcGFnZSBhbmQKPiA+IHRoZSBzZWN0aW9uIHdoaWNoIGNyZWF0ZXMg b25lIGxhcmdlIGZsYXQgSFRNTCBvciBQREYgZmlsZQo+ID4gaHR0cDovL2VuLndpa2lib29rcy5v cmcvd2lraS9TdHJhd19CYWxlX0NvbnN0cnVjdGlvbi9QcmludF92ZXJzaW9uCj4gPgo+ID4gUGVy aGFwcyB0aGF0IHN5c3RlbSB3b3VsZCBvZmZlciBzb21lIGFkdmFudGFnZXM/Cj4gPgo+ID4gVGhl IChmdXR1cmUpIFN0YWJsZSBNYW51YWw6Cj4gPiAqIEEgZ2VuZXJhbCBfYmlnXyBncmlwZSBJIGhh dmUgYWJvdXQgZWxlY3Ryb25pYyBtYW51YWxzIGdlbmVyYWxseSBpcyBob3cKPiA+IG9uZS13YXkg dGhleSBhcmUuIEl0IGlzIG5vdyBzbyBlYXN5IHRvIGhhdmUgYW4gbGluayBvZiBzb21lIHNvcnQg Zm9yCj4gPiBmdXJ0aGVyIGNsYXJpZnlpbmcgb3IgcXVlc3Rpb25zIG9uIGVhY2ggcGFnZSBvZiB0 aGUgbWFudWFsIHRoYXQgSSByZWFsbHkKPiA+IGRvbid0IHVuZGVyc3RhbmQgd2h5IGFsbCBtYW51 YWxzIGRvbid0IGhhdmUgb25lLgo+ID4gVGhlIGJlc3QgZXhhbXBsZSBJIGFtIGF3YXJlIG9mIGlz IHRoZSBvbmxpbmUgbWFudWFsIGF0IHBocC5uZXQKPiA+IGh0dHA6Ly93d3cucGhwLm5ldC9tYW51 YWwvZW4vaW5kZXgucGhwCj4gPiBJIHRoaW5rIHBhZ2VzIGxpa2UgdGhpcyBvbmUgc2hvdyBob3cg dGhlIGNvbW1lbnRzIGNhbiBoZWxwIGNsYXJpZnkgYW5kCj4gPiBleHBhbmQgdGhlIG1hbnVhbDoK PiA+Cj4gaHR0cDovL3d3dy5waHAubmV0L21hbnVhbC9lbi9sYW5ndWFnZS50eXBlcy50eXBlLWp1 Z2dsaW5nLnBocCNsYW5ndWFnZS50eXBlcy50eXBlY2FzdGluZwo+ID4gV2hlbiBkb3dubG9hZGlu ZyB0aGUgbWFudWFsIG9uZSBjYW4gY2hvb3NlIHRvIGluY2x1ZGUgdGhlIHVzZXIgY29tbWVudHMK PiA+IG9yIG5vdC4KPiA+Cj4gPiBTbywgd2hhdCdzIG5leHQuIEFuZCB5ZXMgSSdsbCB0cnkgYW5k IGhlbHAgZWRpdCB0aGUgd2lraSBtYW51YWwuCj4gPgo+ID4gRHVuY2FuCj4gPgo+ID4KPiA+Cj4g LS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0t LS0tLS0tLS0tLS0tLS0tLQo+ID4gVGhpcyBTRi5uZXQgZW1haWwgaXMgc3BvbnNvcmVkIGJ5OiBN aWNyb3NvZnQKPiA+IERlZnkgYWxsIGNoYWxsZW5nZXMuIE1pY3Jvc29mdChSKSBWaXN1YWwgU3R1 ZGlvIDIwMDguCj4gPiBodHRwOi8vY2xrLmF0ZG10LmNvbS9NUlQvZ28vdnNlMDEyMDAwMDA3MG1y dC9kaXJlY3QvMDEvCj4gPiBfX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fX19fXwo+ID4gR3JhbXBzLWRldmVsIG1haWxpbmcgbGlzdAo+ID4gR3JhbXBzLWRldmVsQGxp c3RzLnNvdXJjZWZvcmdlLm5ldAo+ID4gaHR0cHM6Ly9saXN0cy5zb3VyY2Vmb3JnZS5uZXQvbGlz dHMvbGlzdGluZm8vZ3JhbXBzLWRldmVsCj4gPgo+Cg== |
From: <rom...@ya...> - 2008-01-23 20:36:21
|
xml2po is a good tool for manual localisations. Maybe, we need to keep a XML based format as template. Benny Malengier a écrit : > Erik is writing a python script to extract the wikimedia syntax to html. > That would then work locally > > Anyway, the previous manual was mainly written by the main developers, > and today's developers do not appear to be very documentation oriented, > and a messy documentation is in my book still better than no > documentation. My experience is that non-developers have problems with > the old docbook style of manual and are daunted to start > patching/editing that. The wiki is there to get those people involved. I > think that works a bit, but only on very specific subjects at the moment. > > As I see it, if the content is there, a good "editor/administrator" > could quickly rework it to a structured book in a couple of days. The > wiki is there to create that content in the first place. Looking at the > edit history, not many people are helping out at the moment though. > > Don agreed in the beginning to this setup under the pretext: if the > content is there, somebody can do a docbook manual based on that. > My idea to start it though was to get more people involved and to avoid > a complete stale documentation, which is what we would have with the old > format. For me, the wiki is good enough as a manual. I won't stop others > putting effort into a docbook though. > > I do think that before release of 3.0, we have to do a documentation > week: no commits allowed, and everybody must show at least 10 saves on > manual to retain commit rights ;-) > > Benny > > 2008/1/23, Jérôme <rom...@ya... <mailto:rom...@ya...>>: > > I would like to try Wikimedia DTD to XML (SGML, docbook) on current wiki > http://www.gramps-project.org/wiki/index.php?title=Manual_Generation_3.0#XML_to_XML > <http://www.gramps-project.org/wiki/index.php?title=Manual_Generation_3.0#XML_to_XML> > > But I do not what is possible. > > > Duncan Lithgow a écrit : > > Recently I can see that the decision has been made to not ship the > > manual in further releases for the time being. I'm one of those who > > thinks this is far from ideal and would like to talk a bit about our > > options... > > > > The 'unstable' Manual: > > * The current Online Wiki is looking nice, and I've been tempted > to work > > on it every now and then, but there is no imposed structure so I'm > > concerned that it will quickly become a confusing mess if lots of > people > > try to simultaneously take it in different directions. Wiki > software is > > good for making documents quick and easy - but weak on structure. > > ** An attempt at addressing this can be seen at the > > http://en.wikibooks.org/wiki/Main_Page > <http://en.wikibooks.org/wiki/Main_Page> website. The section/pages of > > each 'wikibook' there have a hierarchical relationship to each other. > > This forces contributors of new content to always consider the > > appropriate place for their content. > > An example, simply because I organised it so I can answer questions > > about it, is the > http://en.wikibooks.org/wiki/Straw_Bale_Construction > > wikibook. You'll notice the contents boxes easily added on each > page and > > the section which creates one large flat HTML or PDF file > > http://en.wikibooks.org/wiki/Straw_Bale_Construction/Print_version > > > > Perhaps that system would offer some advantages? > > > > The (future) Stable Manual: > > * A general _big_ gripe I have about electronic manuals generally > is how > > one-way they are. It is now so easy to have an link of some sort for > > further clarifying or questions on each page of the manual that I > really > > don't understand why all manuals don't have one. > > The best example I am aware of is the online manual at php.net > <http://php.net> > > http://www.php.net/manual/en/index.php > > I think pages like this one show how the comments can help > clarify and > > expand the manual: > > > http://www.php.net/manual/en/language.types.type-juggling.php#language.types.typecasting > <http://www.php.net/manual/en/language.types.type-juggling.php#language.types.typecasting> > > When downloading the manual one can choose to include the user > comments > > or not. > > > > So, what's next. And yes I'll try and help edit the wiki manual. > > > > Duncan > > > > > > > ------------------------------------------------------------------------- > > This SF.net email is sponsored by: Microsoft > > Defy all challenges. Microsoft(R) Visual Studio 2008. > > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > > _______________________________________________ > > Gramps-devel mailing list > > Gra...@li... > <mailto:Gra...@li...> > > https://lists.sourceforge.net/lists/listinfo/gramps-devel > > > > > > ------------------------------------------------------------------------ > > ------------------------------------------------------------------------- > This SF.net email is sponsored by: Microsoft > Defy all challenges. Microsoft(R) Visual Studio 2008. > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > > > ------------------------------------------------------------------------ > > _______________________________________________ > Gramps-devel mailing list > Gra...@li... > https://lists.sourceforge.net/lists/listinfo/gramps-devel |
From: James G. S. (jim) <jg...@sa...> - 2008-01-23 23:22:17
|
Duncan Lithgow wrote: > Recently I can see that the decision has been made to not ship the > manual in further releases for the time being. I'm one of those who > thinks this is far from ideal and would like to talk a bit about our > options... > > The 'unstable' Manual: > * The current Online Wiki is looking nice, and I've been tempted to work > on it every now and then, but there is no imposed structure so I'm > concerned that it will quickly become a confusing mess if lots of people > try to simultaneously take it in different directions. Wiki software is > good for making documents quick and easy - but weak on structure. > ** An attempt at addressing this can be seen at the > http://en.wikibooks.org/wiki/Main_Page website. The section/pages of > each 'wikibook' there have a hierarchical relationship to each other. > This forces contributors of new content to always consider the > appropriate place for their content. > An example, simply because I organised it so I can answer questions > about it, is the http://en.wikibooks.org/wiki/Straw_Bale_Construction > wikibook. You'll notice the contents boxes easily added on each page and > the section which creates one large flat HTML or PDF file > http://en.wikibooks.org/wiki/Straw_Bale_Construction/Print_version > > Perhaps that system would offer some advantages? That site does look pretty impressive, including the example book. > > The (future) Stable Manual: > * A general _big_ gripe I have about electronic manuals generally is how > one-way they are. It is now so easy to have an link of some sort for > further clarifying or questions on each page of the manual that I really > don't understand why all manuals don't have one. > The best example I am aware of is the online manual at php.net > http://www.php.net/manual/en/index.php > I think pages like this one show how the comments can help clarify and > expand the manual: > http://www.php.net/manual/en/language.types.type-juggling.php#language.types.typecasting > When downloading the manual one can choose to include the user comments > or not. I believe mysql manuals have some similarities: http://dev.mysql.com/doc/refman/5.1/en/index.html > > So, what's next. And yes I'll try and help edit the wiki manual. I get a little discouraged that these good suggestions (and I include good gripes) may get forgotten. Email lists are like that. Unless somebody acts, the discussion cools until raised in some subsequent discussion. I don't know what to do about that in a all-volunteer organization, especially a small one. I suppose the best might be to get it into the tracker as a feature request. Suggestions, gripes, whines would all be valid commentary, I would say. Regards, ..jim |
From: Brian M. <br...@gr...> - 2008-01-24 02:57:19
|
Jim, > I suppose the best might be to get it into the > tracker as a feature > request. Suggestions, gripes, whines would all be > valid commentary, I > would say. There is an entire "project" on the bug tracker for exactly that reason. Feel free to file issues under that project. ~Brian |
From: James G. S. (jim) <jg...@sa...> - 2008-01-24 04:15:11
|
Brian Matherly wrote: > Jim, > >> I suppose the best might be to get it into the >> tracker as a feature >> request. Suggestions, gripes, whines would all be >> valid commentary, I >> would say. > > There is an entire "project" on the bug tracker for > exactly that reason. Feel free to file issues under > that project. Ahh ok, wouldn't you know. I probably skipped some email details last week. :-[ Thanks, ..jim |