Comments:How to Help
[Edit]

Translating to Hungarian

Archived from the Feedback page:

Hello, I would like to translate the language files to Hungarian. --bDaneE 26-Jul-2006 23:49 PDT

That would be great! Are you familiar with Java ApplicationResources.properties files? If so, simply update the /WEB-INF/classes/ApplicationResources.properties file in the latest JAMWiki 0.1.0 release (see the link on the front page) or else grab the trunk/src/resources/classes/ApplicationResources.properties file from Subversion (see Building from Source for guidelines). Once the file has been translated you can rename it to ApplicationResources_hu.properties and then re-submit it to jamwiki.org (see Special:Upload), or you can email it to me, or if you'd like to do additional development then I can set you up with Subversion access and you can submit the file there - whatever method you prefer is fine with me. Once the file is done please let me know how you would like to be credited in the CREDITS.txt file. Also, just to be sure, all contributions need to be released under the LGPL, so hopefully that's OK with you. Let me know if you have any questions or if I can help out, and thanks for contributing! -- Ryan 27-Jul-2006 00:28 PDT

I nearly finished the translating. Can you tell me a place where I can test the language file? (Message admin.caption.uploadheader occoured twice in the file) --bDaneE 27-Jul-2006 02:35 PDT

If you have JAMWiki running on your server you should be able to simply copy the ApplicationResources_hu.properties file into your /WEB-INF/classes directory and then restart the server. Assuming your browser is Hungarian JAMWiki should automtically display in Hungarian. If your browser is NOT Hungarian then you'll have to use a programming trick to display Hungarian: you can manually edit the /WEB-INF/jsp/page-init.jsp file and add the following line prior to the <f:setBundle /> line:
<f:setLocale value="hu_HU" />
If you then restart your web application server the site should display in Hungarian. If you don't have JAMWiki running on your machine you can upload the file here and I'll add the translation file to jamwiki.org so that you can test. Also, thanks for the note about the duplicate message string, I've fixed it in the source repository. -- Ryan 27-Jul-2006 09:59 PDT
I just got the file you uploaded, and I've added it to the source repository so it will be included in JAMWiki 0.1.1. Please let me know how you would like your credit to appear in the CREDITS.txt file - for reference, the existing JAMWiki credits appear below: 
  Developers:               Ryan Holliday (wrh2)
  Graphic Design:           AleXey "lexis" Rumyantsev (lexis@mail.ru)
  Translations:
     Chinese:               Jiading (ewen0930)
     Hungarian:             ???
Thank you very, very much for helping out! -- Ryan 28-Jul-2006 01:29 PDT
Write Daniel Tar (bDaneE). And, of course, I will help you with translating the future versions, too. --bDaneE 28-Jul-2006 05:24 PDT
Done! Translations for Hungarian will be in the 0.1.1 release. I'm planning on adding a web interface to hopefully make managing translated strings easier for the next release as well, and if you (or anyone else) has any suggestions on how to make it easier to enter translations or keep them up-to-date, please let me know. -- Ryan 28-Jul-2006 10:53 PDT
[Edit]

Translation Updates

Archived from the Feedback page:

I've made several updates today that should make translations easier. First, the Special:Translation tool will now save versions of translations updated using that tool, so hopefully it should now be impossible for me to accidentally overwrite someone's translations (see JAMWiki:ApplicationResources hu.properties for an example). Also, a record will appear on the Special:RecentChanges page when someone updates a translation file with the tool, which should make it easier for me to tell when a file was updated. Note that JAMWiki:ApplicationResources hu.properties cannot be edited directly - it MUST be updated either by using the Special:Translation tool or by adding a new ApplicationResources_hu.properties directly to the file system.

Second, uploading and downloading files from the Wiki should work now, so users who would prefer to just upload ApplicationResources.properties files can do so, and I can then use those to update the code. The code will also now add a record on Special:RecentChanges when a file is updated, so I should notice if someone updates a translation file.

Last of all, I've made sure that the existing translators (User:ewen0930, User:bdanee, User:axelclk and User:g9adm) all have access to Special:Translation. If anyone else wants to contribute translation files please let me know, or else just upload an appropriate ApplicationResources file to the site.

Please let me know if there's anything else I can do to make the translation work easier - I really, really appreciate the work people have done translating JAMWiki! -- Ryan 27-Aug-2006 21:00 PDT

Hi.. Just updated the Danish translation. It would be really nice if there were some easy way of identifying new entries in the translation file. Currently I need to read through all entries. Maybe new texts could be highlighted in some way. Anders 17-Jan-2007

Thanks for the update! The easiest way tell what's changed is either to do a diff on the ApplicationResources.properties file using Subversion, or to view the diff on jamwiki.org - use the History tab for JAMWiki:ApplicationResources.properties to see what's changed since the last time you made any updates. If you have suggestions about how that could be made easier let me know, and I'd be glad to implement. -- Ryan 17-Jan-2007 21:08 PST
[Edit]

Unit Test Coverage

The following was copied from an email but is of general use. The subject was what code is most in need of unit test coverage:

The parser code (org.jamwiki.parser.jflex) is probably the place where unit tests are most helpful, as it seems like any changes to the parser invariably break something. The parser will probably need to be completely re-implemented at some point, but for now it works and there are other areas that are higher on the priority list.

One of the problems I've run into with unit tests is that much of the code depends on having access to the JAMWiki environment - web application context, database connection, properties, etc - and tests will fail without that information. There are test frameworks out there such as Cactus, but I haven't used any of them and haven't had the time to actually figure out if any are worth implementing. If you have any familiarity with those it would be a HUGE help to get that kind of test coverage in place. -- Ryan 14-Jul-2007 11:16 PDT

[Edit]

DB2/400

Moved from the Comments:Feedback page:

I'll be more than happy to help on DB2/400 port. What do you need ?

I recall I've have to change the ASCII from TEXT to CLOB, and remove the lower(login) in the create index.

[Edit]

Contributing

Moved from the Feedback page:

I got an email today from someone interested in contributing to JAMWiki, but my reply email bounced. In general, anyone who wants to contribute should read How to Help#Programmers, which outlines the steps required to get access to the Subversion repository, and also outlines how to make contributions to the project (basically: discuss first, and make contributions that are small and incremental rather than submitting a 10,000 line patch that affects a bunch of files). -- Ryan 23-May-2007 11:36 PDT

[Edit]

Automated unit tests

Archived from the Feedback page:

I've been looking into automated testing for a while and came across http://www.junitfactory.com/ which is run by Agitar. Reading the bit in How to Help about unit tests and thought that here's a way to test out their system and possibly help contribute to JamWiki in a minor way as well. I'd be interested to know if the tests it generates are actually useful but can't at the moment try it on my own software because it's not open source. So I ran it on the 0.5.1 JamWiki source and the results are here: agitar.zip. In my Eclipse, the test source folder is 'agitar/test', then the packages are org.incava.util.diff, org.jamwiki, org.jamwiki.authentication etc.

The package structure doesn't follow the guidelines you set out Ryan, because they're autogenerated on default settings but it would be good to see whether they're any cop anyway - maybe someone who knows the code would like to have a look and run them.

Cheers, Oliver 01-Feb-2007 08:30 PST

Thanks, provided work hasn't sucked away all inclination to look at computer code I'll look through this when I get home tonight. I've found that JUnit is somewhat limiting due to the fact taht much of the JAMWiki code has to be run as a web application with a connection to the database, so any way to improve the automated testing would be a good thing. -- Ryan 01-Feb-2007 09:14 PST
Taking a quick look through the generated tests, some editing & trimming is probably needed (for example, the cache & database tests won't work except as part of a web application, and some of the Environment class tests look dubious) but they could definitely be a very useful base for expanding the JAMWiki test coverage. If I can ever find some free time I'd be glad to pick & choose amongst the automatically generated code to add to the (limited) set of existing JAMWiki JUnit tests; alternatively anyone else is welcome to take a stab at using these tests to augment the existing JAMWiki test suite as well.
I'm not sure if that was the feedback you were looking for, but the quick summary is that this tool does appear to have some value, although like many automated tools there's a need for human judgment. Luckily, the human judgment part looks pretty easy. -- Ryan 01-Feb-2007 20:23 PST
I've done a bit of editing and added the tests for the org.jamwiki.utils package. These will probably be most useful as a base to build from, but a sufficiently motivated person could probably turn them into a very useful test suite with some work. Thanks for the pointer! -- Ryan 12-Feb-2007 22:52 PST
Hi Ryan, for testing our webapplication we use canoo webtest. It is open source and using internal htmlunit. The test will be defined in xml and the test-interface is the web-html page and interaction with the user. We do count on our webtests as reliable instance of the actual state of our releases. --- Michael Habbert 17-Feb-2007 05:56 PST
I'll give this a look when I get a chance. Thanks for the pointer! -- Ryan 18-Feb-2007 00:54 PST
See: http://webtest.canoo.com/webtest/manual/WebTestHome.html
Just a quick note to say that during some recent updates to the parser code these automated tests have proven hugely helpful. Thanks again for generating these. -- Ryan 12-Apr-2007 23:38 PDT
[Edit]

Classes\Pages

Archived from the Feedback page:

In WEB-INF\classes\pages there are source files like BottomArea.txt, StyleSheet.txt and so. What's the purpose of these files as, for example, StyleSheet.txt has no effect on the pages created in the wiki? I have changed StyleSheet in my wiki and it is different page than the one in \pages directory. Thank you. --Zajoman 15-May-2007 01:35 PDT

See How to Help#Default Topics - those files are used during setup to create the initial topics, but after that they are unused. -- Ryan 15-May-2007 08:48 PDT
[Edit]

Nice Table Class

Archived from the Feedback page:

I found out that there are no nice table classes in the style sheet here. I made up one, so if you like it, you may add it to the style sheet.

table.zajotable { text-align: center; margin: 1em 1em 1em 0; background: #e0e0e0; border: 1px black solid; border-collapse: collapse; }

table.zajotable th, table.zajotable td { border: 1px black solid; padding: 7px; }

table.zajotable th { background: #c0c0c0; text-align: center; }

table.zajotable caption { margin-left: inherit; margin-right: inherit; font-weight: bold; }

--Zajoman 15-May-2007 04:07 PDT

Thanks, I'll probably be making some style updates for JAMWiki 0.6.0 so I'll take a look at this. Feel free to submit any other ideas you have for cosmetic improvements as JAMWiki can use all the help it can get to improve its look! -- Ryan 15-May-2007 21:35 PDT
[Edit]

RFD: strictness of translations

Archived from the Feedback page:

During the last week I was able to contribute a bit regarding JAMWiki translation (to German). In particular to all native German speaking JWians, how rigorous should we handle translation? I, for my part, prefer translating link to Verweis and button to Schaltfläche or Knopf, for all I care. What's the consensus? -- fmr 30-Aug-2007 03:17 PDT

I wouldn't want to disturb that fierce discussion ... ; ... but I think soomething else to consider in that context is to whom explaining texts target. Shall we suppose that really everyone should be able to administer JW, so one lacking technical vocabulary? Should we translate terms like "parsing" to more colloquial expressions? -- Frank 12-Sep-2007 04:41 PDT

There's definitely an ebb and flow to discussions around here - one week there will be a number of people debating everything, and then it goes quiet for a month :) My preference would be that as much as possible the labels and text cater to a non-technical crowd, but given my own technical background I'm not always great at coming up with good labels. Any suggestions for improvement would be much appreciated. -- Ryan 12-Sep-2007 08:02 PDT
I've been concerned about that for some more seconds... In the first place I am thinking about anglicisms in non-english labels. Trying to translate terms like "parser" or "cache" to be understandable for everyone might go too far because of bloating labels. Caught myself thinking that technical terms being links (within labels) to e.g. Wikipedia could be an approach (a tiny contribution as a consistent continuation of the internets open information paradigm). -- Frank 13-Sep-2007 02:20 PDT
[Edit]

Translation

Archived from the Feedback page:

I don't know how can i translate some words like Saturday ,May.

[Edit]

Spanish translation

Archived from the Feedback page:

Hi! I want to do the Spanish translation of JAMWiki. I've already read the How to Help#Translators section so I think I'm ready to get my hands on it :-9 -- Angel Pinazo

Great! I've updated your account so that you should be able to access Special:Translation - you may need to log out and then log in again for your account to update. Altnernatively, if you would prefer to contribute directly to Subversion just let me know your Sourceforge ID and I can set you up with access there. Thanks for helping out! -- Ryan 18-Nov-2007 10:07 PST
Is it OK to credit you in the CREDITS file as "Angel Pinazo (AngelPinazo)"? Most people use their real name and jamwiki.org login. Thanks again for updating the translations! -- Ryan 18-Nov-2007 11:06 PST

That's a short name. My complete name is Angel Luis Pinazo Perpiñán - yes, I have two first names and two last names :-). If it is too long, Angel Pinazo would be fine. I'll finish the translation by next weekend, I guess. -- Angel Pinazo

Thanks, I've updated the CREDITS.txt file and committed everything to Subversion. The translations are much appreciated - I could be wrong, but I don't think the original Spanish translations have been updated since version 0.0.1, so it's great to have them updated. Let me know if you run into any problems or have any questions. -- Ryan 18-Nov-2007 20:24 PST
[Edit]

Adding new features

Archived from the Feedback page:

I want to add some source to jamwiki but I desperately fail with the project structure, maven and the deployment.
I have managed to do the deep eclipse intergration, also it's not complete and misses some important spots.
After the deployment with WTP within eclipse I get:
SCHWERWIEGEND: Error configuring application listener of class org.springframework.web.context.ContextLoaderListener java.lang.ClassNotFoundException: org.springframework.web.context.ContextLoaderListener
But I do have a bunch of maven dependencies.
I have inspected the WEB-INF/lib folder in the wtpwebapps and there is no lib folder, that's the reason the app fails to launch.

Why does it has to be that complicated??

How can I make the app run?

Finally, I mananged to run the app within eclipse and WTP. The description how to make it run with eclipse deep integration is crap. I will change it very soon. Since it's running and I modified some java source, the app crashes with hsqldb is locked by another instance. How can I overcome this obstacle? --Michael-O 25-Nov-2007 05:59 PST

I don't personally use Eclipse, but I believe User:RegisDecamps does and may be able to provide some insight. If there is some additional information you can provide on the Building from Source page to make this process easier for others then it would be much appreciated. As to the HSQL error, I've never personally seen that problem, but it may be related to failures during failed builds/installs - deleting the contents of your file-system directory (particularly the /database/ folder) might help. -- Ryan 25-Nov-2007 13:00 PST
Ryan, thank you very much for your reply. Are you on netbeans? I use WTP in my daily work, it is really teriffic and helps a lot in developement of webapps. I will definitely update the Building from Source page and will try to resolve the eclipse and hsqldb issue with that user. I really want to get this run and commit a lot of code especially the mail support part since this project ist really great and stunning! --Michael-O 25-Nov-2007 14:14 PST
Edit: I am already on heavy investigation for a more mature maven/wtp/eclipse integration to overcome all obstacles and hopefully conclude my investigations in the next couple days. --Michael-O 25-Nov-2007 15:23 PST
I've never been a big fan of IDEs, although everyone at work is using Eclipse so I may end up switching later on. In the mean I just use Notepad++, which gives syntax highlighting and is lightweight.
Let me know if you figure out what might be causing any HSQL or other issues, and thanks for helping out! -- Ryan 25-Nov-2007 17:18 PST
Hi Ryan, can you give me some pointers where the HSQL database is intantiated? (i.e. lock is created). I have to look the the destroy method on context shutdown. I am absolutely unaware of spring :-( --Michael-O 26-Nov-2007 03:48 PST
When you set up the wiki you had to specify a "file system directory" value - you can check this value on the Special:Admin page. The lock file is kept under that directory in the /database/ folder. If you want to know where in the code the lock is instantiated, that should be internal to the HSQL code, which I haven't looked through - luckily using the HSQL database hasn't required being familiar with their database code. Hope that helps, but let me know if I misunderstood the question. -- Ryan 26-Nov-2007 09:05 PST
[Edit]

Telugu (india) Translation

Archived from the Feedback page:

Hello, I would like to translate the language files to Telugu (te) (3rd Biggest spoken language in India) 14th place world. How can i submit the ApplicationResources_te.properties once i am done? --Durga 06-Dec-2007 12:01 PST

That would be great! Once the file is ready you can either upload it here using the Special:Upload. Just let me know what name to use to credit you in the CREDITS.txt file. Also, if you would like access to the Special:Translation tool here on jamwiki.org just let me know and I'll modify your account permissions. Thanks for contributing! -- Ryan 06-Dec-2007 12:18 PST

thats great. Please update my access. --Durga 17-Dec-2007 14:33 PST

Done. You may need to log out and log in again to see the change, but there should be an "Admin" link on the top right part of your screen. You can also just click on Special:Translation?language=te. -- Ryan 17-Dec-2007 15:07 PST
[Edit]

Galician translation (and some others)

Archived from the Feedback page:

I would like to translate JAMWiki to Galician, if nobody has done it jet, and I can also help with Spanish and Portuguese, if needed. Cheers.

That would be great! See How to Help#Translators for a list of ways to contribute translations. If you would prefer to use the Special:Translation tool on jamwiki.org just let me know and I'll modify your account to give you access. -- Ryan 14-Dec-2007 07:39 PST

Thanks, I would like to use the tool, if it is the easy way to do it...--mmeixide 14-Dec-2007 16:06 PST

I've updated your account permissions, but you may need to logout & login again to see the change. You should see an "Admin" link in the top right corner of the page, and from there you can get to the translation tool. Alternatively, for Galician you can follows this link: Special:Translation?language=gl. Thanks again for offering to help, and please let me know if you have any questions. -- Ryan 14-Dec-2007 17:45 PST
Thanks for all of your work! I've added you to the CREDITS file as "Manuel Meixide (mmeixide)", but please let me know if that should be changed. In addition, I realized that the code which currently displays a list of available languages / locales on Special:Account does not include Galician on jamwiki.org, so I've added a quick hack and will investigate fixing this more appropriately for the next release. Thanks again, and please let me know if you have any suggestions for making it easier to enter & maintain translations. -- Ryan 15-Dec-2007 09:10 PST

I have finished the Galician translation. Also I have completed the Spanish, translating some sentences left there. The translation system you have here is easy to use: I will try to find somebody to check my translation. Cheers --mmeixide 16-Dec-2007 16:20 PST

Thanks for all of your work! I don't have the most recent update in Subversion yet, but will update it tonight for inclusion in the next release, which will probably happen after the holidays. I'll also restart the application server on jamwiki.org tonight so that your updates are all available here. -- Ryan 17-Dec-2007 07:48 PST
[Edit]

Portuguese translation

Archived from the Feedback page:

I have started the Portuguese translation of JAMWiki, but more people is needed to work on it to be ready for next release. I will try to get more people involved.

How many languages do you speak??? I'm impressed :) -- Ryan 18-Dec-2007 20:08 PST

Not so many :) I studied Spanish and some English at school. At that time Galician was almost forbiden. So, I learned it talking with people and reading some books. And finally, I learned Portuguese (that is close to Galician as it has the same origin, the Galaico-portuguese language) because I spent 3 years living in Portugal and also hearing a lot of Portuguese and Bazilian music :). --mmeixide 22-Dec-2007 04:40 PST