Initial Setup

ResX Translation Helper was developed with Visual Studio 2008 but it should also work well with Visual Studio 2005.

  1. Extract downloaded zip file into your localhost directory, e.g. c:\inetpub\wwwroot\resx.
  2. Configure your IIS for this new application
  3. Open Visual Studio, select “File” “Open Webpage” and navigate to your URL created in step 1 and 2, e.g. http://localhost/resx

Initial Configuration

The following configurations have to be updated:

  1. Update web.config
    In web.config you find 2 application settings:
    		<add key="UserFile" value="D:\private\Users.xml"/>
    		<add key="ProjectDirectory" value="D:\private\projects\"/>
    Change the value of these 2 settings according to your file structure.
    -> IMPORTANT: To increase security, both locations should not(!) be available via webbrowser. So recommendation is to create a new folder (e.g. D:\private\) outside your webpath.
  2. Update / create users.xml
    Enter your own Mailaddress in users.xml. Leaving ‘hash’ empty means that you could login with an empty password. In the project node select the language code (see MSDN for list of allowed codes) and enter your project name.
  3. Update / create XML in Project-Directory
    In Project-Directory (as configured in step 1)  rename existing “Hatcoach.xml” to your own projectname, e.g. “MyProject.xml”. Then update the XML-values: Enter your mail address as Admin. In the FTP-Section enter data of your FTP-Connection where the translated files should be uploaded to. Enter Servername, Path, username and password. In the Path-node, enter the whole path where the files should be uploaded to, e.g. “/App_LocalResources/%LANG%/”
  4. Create Project subfolder
    In Project-Directory (as configured in step 1) create a new subfolder with your projectname, e.g. “MyProject”.
  5. Copy Resource files
    Copy your (english) default resource files  into the new project directory created in Step 4.
  6. Navigate to your URL (e.g. http://localhost/resx/default.aspx) and start translating :-)


How to add a new project

ResX Translation Helper supports using multiple projects. In the initial setup we have already configured a first project, here’s how to add another one:

  1. In your project directory (as configured in step 1 of initial setup) create a new subdirectory with the name of your new project.
  2. Create a new copy of your existing project xml-file (e.g. Hatcoach.xml) and name it like your new project. Modify the xml-nodes to your needs.
  3. Copy your (english) default resource files into the new project directory created in step 1.
  4. If you already have some translators for the new project, open users.xml (see step 1 of initial setup) and add the new project to the existing user nodes.

How to add new translators

Once you have setup your projects you will hopefully find some users helping you to translate your files into different languages. Follow these steps to add a new translator:

  1. Add a new User-Node in users.xml (see also step 2 of Initial Setup). Leave attribute ‘hash’ empty so that user could login just with his email address.
  2. Inform user how to login via email.
  3. That’s it. you don’t need to create any subdirectory or copy any files. This will all be done automatically.

How to add new files

Once your project is setup, you might want to add new resource files for translation. Here are the steps:

  1. Add the new default (english) resx-file to your Project Subfolder, e.g. D:\Private\MyProject
  2. Delete all [language].xml files (e.g. “de.xml”, “it.xml”, “fr.xml” etc.) from your project subfolder.
    As soon as a translator logs in the, these language files are automatically recreated if they do not exist.

How to update existing files

If you have updated an existing resx-file, just upload it to your project Subfolder, e.g. D:\Private\MyProject. The new values are automatically available for translation.

Example File Structure on Webserver


Last edited Nov 26, 2010 at 6:21 PM by Kai, version 8


No comments yet.