This is an old revision of the document!
=How to collaborate?=
If you want to help us to turn
'Tupi' into the best free tool for animation 2D projects, there are many ways to do it. These are some of them:
'As Digital Artist'
'Tupi' in your computer and make yourself an expert creating animations
* Tell to your friends about this project
* Make manuals, videos or any kind of content to support another animators wanting to learn how to use
* Create and post little animation projects in our gallery
* Report the bugs you find in the software from our website
* Visit our forums to solve questions and help another animators
* Make a donation to the project. From USD 1 dollar, any contribution you make will help us to hire more developers, acquire better hardware to develop and pay the maintenance of our website. Your support will become in shorter development cycles and better versions of
* Download the source code of the project and study it
* Using the Doxygen tool, help us to write documentation of all the software components of
* Make and post diagrams and visual resources to help another programmers to understand the project's architecture in a simple and quick way
* Check our bug reports and help us to fix the bugs reported by users. Create patches with the fixes and share them with our development team
* Check our To-Do list and help us to implement any of the new pending features
* Invite to your students to study and use
* Include 2D animation homeworks as part of the activities in your classes
* Encourage your students to create small animations as inspiring examples for other students, other classes, even other schools. You can make your own examples too!
* Write tutorials and invite your students to help you in the process
Regardless of the role you choose, all your contributions as member of this community are fundamental for the development and enhancement process of
'Tupi'. Join the team!
=Help with Translations=
Due the constant flow of new information coming from our development team and our need of communicate it to the community in many languages, we have decided to make a call to everyone with translation skills to help us to translate any kind of documentation from a language to another.
As part of the contents we have to translate constantly, we have:
* News and Announcements from our website
* Tutorials, Manuals and Examples
'Tupi' language support files (required to use the software in many languages as English, Spanish, Portuguese, Catalan, etc)
For the news and tutorials, the only prerequisite is your wish to help us. All you have to do is send us a mail, telling what is the specific text you want to translate or if you want us to assign you one: always there is something to translate!
On the other hand, What means language support? In simple words, it is about the feature of a software application to show all its messages in a specific language. If you want to use
'Tupi' in Chinese, Arabian, French or any other of language you are interested, then, you are in the right place to collaborate.<br/>
To deal with the language support files, it's necessary that you get some basic training about the tools and procedures that we use to create and manage this kind of files. Follow the next instructions and you'll become one of our most important translators:
'Learn to use linguist and understand how it works.' Let's start from the beginning.
'Tupi' is a software application developed using the Qt API, which is written in C++. The good news is that you don't have to learn Qt or C++ to help us translating stuff.
Nevertheless, it's important that you understand that Qt is not just a development API, but a set of many additional tools that make easier the development of applications. One of them is
linguist, a very simple software which is included with the Qt installation and let you create new language supports for
'Fig #66. Linguist Application'
If you have installed Qt in your computer, surely you already have
linguist installed too. Search for the application launcher in the main menu of your graphical environment, in the Programming section:
'Fig #67. Launching Linguist Application'
The basic input for this utility is a plain text file with extension “.ts”. Using this file you could translate all the messages included in
'Tupi' to the language you want to. A good news is that you don't have to start from the scratch, because we already have one (tupi_es.ts) from our website. Download it and rename it counting on the language you want to translate it. In example, if you want to create the Spanish support for
'Tupi', then you should rename the file to tupi_es.ts and open it from the linguist software like this:
Now, let's take a look to the main components of
linguist, specifically those that we are going to use. The first is the context list. Its name sounds a little complex, but is just a list of “word categories”. We mean, every item of the list that we see at the picture, simply represents a set of words related to that context.
'Fig #69. Context List'
The next component, is the list of words or messages related to a context. These messages are used by
'Tupi' and they are our target to translate. Every context can have a variable number of messages to translate. Regardless of it, all the words must be translated.
'Fig #70. Words List of a Context'
For now, we already have identified the names of the sets (contexts) and the list of words for every context. Now, let's identify the most important part of the tool, the translation form:
'Fig #71. Translations Forms'
Now, let's see in detail, which are the fields we must take care about, in the translation form:
'Fig #72. Detailed View of the Translation Form'
The field marked in red contains the word we have to translate; in this specific case, the word “Pen”. The field marked in green contains the space where we must write the translation for the word. In this particular case, for the Spanish translation it is: “Lápiz”.
Ok, now that we made an specific example, let's make a general description of the whole process: Once we have opened the language support file (i.e. tupi_it.ts), we must to pick every context (1), one by one. For every context selected, we have to click on every word from the list in the second column of the interface (2), to translate them from the form placed in the bottom side (3). Once we have finished with all the contexts and every word or message has been translated, we will have finished with our mission.
'Fig #73. Main components of the Linguist Application'
Finally, we have to save the changes and send our file by email to the development team. This “.ts” file will be included in further versions of
'Tupi', giving support to a new Language thanks to you!
If you want to learn more about
linguist, you can visit the official manual at: