| 7 | | == How to request for new user agent == |
| 8 | | According to [wiki:XMLRPC API documentation] you need !UserAgent string - please register first on www.opensubtitles.org as user. You can choose own user agent name, please choose your application name and version, so proper !UserAgent name should be something like: '''My Application v0.1''' (please don't use some weird version numbering, such as v2r1 and so on, because we are parsing version). Please fill this form and send it to mail: admin at opensubtitles.org with subject "Register User Agent Request", then you will get confirmation mail. |
| | 8 | == How to request a new user agent == |
| | 9 | According to the [wiki:XMLRPC API documentation], you need a !UserAgent string. Please first register as a user on www.opensubtitles.org. You can choose your own useragent name, and please choose an application name and version number. An example of a valid !UserAgent would be something like: '''My Application v0.1''' (please avoid using a weird version numbering, such as v2r1, because we're parsing version). Please fill the following form and email it to: admin at opensubtitles.org with the subject "Register User Agent Request". You will then get a confirmation mail. |
| 37 | | == How to implement opensubtitles.org support == |
| 38 | | We are not again too much restrict in this area. Everybody knows using just API makes no or minimum real visits to website, where are some banners and stuff, which can make some money at least to donate servers costs, so just follow these simple steps - it is only about promoting our website and making OS brand: |
| 39 | | * in about menu in application add opensubtitles.org logo/favicon with clickable www.!OpenSubtitles.org link/logo to http://www.opensubtitles.org and write something like "Subtitles service allowed by www.!OpenSubtitles.org" ([http://static.opensubtitles.org/favicon.ico Favicon], [http://eduo.info/soleol-support/OpenSubtitlesFavIcon.gif Favicon GIF], [http://static.opensubtitles.org/gfx/logo.gif Logo], [http://static.opensubtitles.org/gfx/logo-transparent.png Logo (transparent)]) |
| 40 | | * in subtitles menu/context menu write something like "Download from !OpenSubtitles.org" |
| 41 | | * if your application doesn't (but in future should be - more uploaded subtitles using program - more subtitles available - more users happy...) support upload please add Upload menu pointing browser to: http://www.opensubtitles.org/upload |
| 42 | | * please put link search on opensubtitles.org - which will open browser to: http://www.opensubtitles.org/search/sublanguageid-all/moviebytesize-$moviesize/moviehash-$moviehash |
| 43 | | * please put http://www.opensubtitles.org link on your application webpage |
| 44 | | * write about opensubtitles.org support at webpage, readme.txt and user guide |
| | 38 | == Implementing opensubtitles.org support == |
| | 39 | Again, we're not very restrictive in this area. Everybody knows that using an API creates few or no real visits to the site, which means no advertising revenue to cover server costs, nor publicity for us. In order to help us keep the site going, please follow these simple steps to help us promote the site and build our brand: |
| | 40 | * In the "about" menu in your application, add an opensubtitles.org logo or icon, with a clickable link to http://www.opensubtitles.org. You could also write something like "Subtitles service powered by www.!OpenSubtitles.org". Here are some logos for you to use: ([http://static.opensubtitles.org/favicon.ico Favicon], [http://eduo.info/soleol-support/OpenSubtitlesFavIcon.gif Favicon (GIF)], [http://static.opensubtitles.org/gfx/logo.gif Logo], [http://static.opensubtitles.org/gfx/logo-transparent.png Logo (transparent)]) |
| | 41 | * In the application's "subtitles" menu/context menu, write something like "Download subtitles from !OpenSubtitles.org" |
| | 42 | * If your application doesn't support automatic uploading (see later - more uploaded subs with your application's link means more subs available, and more happy users!), please add a manual Upload option, pointing the user to: http://www.opensubtitles.org/upload |
| | 43 | * Put a search link pointing to opensubtitles.org, using the following syntax: http://www.opensubtitles.org/search/sublanguageid-all/moviebytesize-$moviesize/moviehash-$moviehash |
| | 44 | * Please put an http://www.opensubtitles.org link on your application webpage. |
| | 45 | * Write about opensubtitles.org support at your webpage, in the readme.txt and in the user guide, if applicable. |
| 46 | | == Your movie player should support automatic uploading == |
| 47 | | Idea is very simple. User is watching some movie with subtitles. If he watched more than 80% of movie with subtitles (and he did not change delay/fps for subtitles) we can say, those subtitles are suitable for watched movie. So why don't upload them? In many cases it should be done in automated way in background (default setting). In player preferences of course user should change login/password, automatic upload enabled/disabled and all other settings. |
| 48 | | * workflow: |
| 49 | | * after 80% of '''watching''' movie (that means user can forward, backward movie, but he must watch at least 80% of current time of movie) launch automatic uploader module in player |
| | 47 | == Supporting Automatic Subtitle Uploading == |
| | 48 | The idea's very simple - if a user watching a movie with subtitles watches 80% or more of the movie (without modifying the delay or framerate during this time), we can safely say that those subtitles are suitable for the movie. In that case, why don't you upload them? In many cases this should be done in automated way, in the background (as the default setting). In your player preferences, user should of course be able to change login/password, enable/disable automatic upload, as well as changing any other settings. |
| | 49 | * Workflow: |
| | 50 | * After 80% of '''watching''' movie (this means user can skip back and forth, but must watch at least 80% of the movie in real-time), launch the automatic uploader module in player, |
| 51 | | * we got movie and subtitles, call [wiki:XMLRPC#TryUploadSubtitles TryUploadSubtitles()] |
| 52 | | * if subtitles are not in database, get IMDB ID from .nfo file or [wiki:XMLRPC#CheckMovieHash CheckMovieHash()] |
| 53 | | * if we don't have IMDB ID, user must find it using [wiki:XMLRPC#SearchMoviesOnIMDB SearchMoviesOnIMDB()] |
| | 52 | * We got movie and subtitles, call [wiki:XMLRPC#TryUploadSubtitles TryUploadSubtitles()] |
| | 53 | * If subtitles are not in the database, get IMDB ID from .nfo file or [wiki:XMLRPC#CheckMovieHash CheckMovieHash()] |
| | 54 | * If we don't have IMDB ID, user should be prompted to find it using [wiki:XMLRPC#SearchMoviesOnIMDB SearchMoviesOnIMDB()] |
