Upgrading.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. <!DOCTYPE html>
  2. <html dir="ltr">
  3. <head>
  4. <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
  5. <title>App/Setup/Upgrading - XOWA</title>
  6. <link rel="shortcut icon" href="https://gnosygnu.github.io/xowa/xowa_logo.png" />
  7. <link rel="stylesheet" href="https://gnosygnu.github.io/xowa/xowa_common.css" type="text/css">
  8. </head>
  9. <body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
  10. <div id="mw-page-base" class="noprint"></div>
  11. <div id="mw-head-base" class="noprint"></div>
  12. <div id="content" class="mw-body">
  13. <h1 id="firstHeading" class="firstHeading"><span>App/Setup/Upgrading</span></h1>
  14. <div id="bodyContent" class="mw-body-content">
  15. <div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
  16. <div id="contentSub"></div>
  17. <div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
  18. <p>
  19. This page describes how to update your XOWA application manually.
  20. </p>
  21. <div id="toc" class="toc">
  22. <div id="toctitle" class="toctitle">
  23. <h2>
  24. Contents
  25. </h2>
  26. </div>
  27. <ul>
  28. <li class="toclevel-1 tocsection-1">
  29. <a href="#Background"><span class="tocnumber">1</span> <span class="toctext">Background</span></a>
  30. </li>
  31. <li class="toclevel-1 tocsection-2">
  32. <a href="#Upgrade_by_an_xowa_upgrade_package"><span class="tocnumber">2</span> <span class="toctext">Upgrade by an xowa_upgrade package</span></a>
  33. <ul>
  34. <li class="toclevel-2 tocsection-3">
  35. <a href="#Upgrade_process"><span class="tocnumber">2.1</span> <span class="toctext">Upgrade process</span></a>
  36. </li>
  37. <li class="toclevel-2 tocsection-4">
  38. <a href="#Upgrade_shelf-life_of_4_weeks"><span class="tocnumber">2.2</span> <span class="toctext">Upgrade shelf-life of 4 weeks</span></a>
  39. </li>
  40. <li class="toclevel-2 tocsection-5">
  41. <a href="#Upgrade_issues_should_fallback_to_xowa_app_packages"><span class="tocnumber">2.3</span> <span class="toctext">Upgrade issues should fallback to xowa_app packages</span></a>
  42. </li>
  43. </ul>
  44. </li>
  45. <li class="toclevel-1 tocsection-6">
  46. <a href="#Upgrade_by_an_xowa_app_package"><span class="tocnumber">3</span> <span class="toctext">Upgrade by an xowa_app package</span></a>
  47. </li>
  48. <li class="toclevel-1 tocsection-7">
  49. <a href="#Upgrade_by_an_xowa_app_package_and_regenerating_the_XOWA_root_directory"><span class="tocnumber">4</span> <span class="toctext">Upgrade by an xowa_app package and regenerating the XOWA root directory</span></a>
  50. </li>
  51. <li class="toclevel-1 tocsection-8">
  52. <a href="#In-app_updater"><span class="tocnumber">5</span> <span class="toctext">In-app updater</span></a>
  53. </li>
  54. </ul>
  55. </div>
  56. <h2>
  57. <span class="mw-headline" id="Background">Background</span>
  58. </h2>
  59. <p>
  60. XOWA has a rapid release cycle, with a new version coming out every week. For more details, see <a href="/wiki/Help/Release_schedule" id="xolnki_2" title="Help/Release schedule">Help/Release_schedule</a>.
  61. </p>
  62. <p>
  63. XOWA releases frequently for a few reasons:
  64. </p>
  65. <ul>
  66. <li>
  67. <b>MediaWiki updates frequently</b>: English Wikipedia and all the other Wikimedia wikis use a <a href="https://www.mediawiki.org/wiki/Version_lifecycle" rel="nofollow" class="external text">continuous integration model</a>. These releases tend to come out very quickly with releases as often as every week. See <a href="https://www.mediawiki.org/wiki/News" rel="nofollow" class="external free">https://www.mediawiki.org/wiki/News</a> for an example of the release schedule
  68. </li>
  69. <li>
  70. <b>XOWA is still young</b>: XOWA was only released in 2012-12-31. Although a lot of features have been added since then, there are still a lot of features to be added.
  71. </li>
  72. <li>
  73. <b>Frequent release philosophy</b>: I personally prefer having frequent releases as opposed to larger infrequent releases. The former is more manageable, and keeps overall development nimble.
  74. </li>
  75. </ul>
  76. <h2>
  77. <span class="mw-headline" id="Upgrade_by_an_xowa_upgrade_package">Upgrade by an xowa_upgrade package</span>
  78. </h2>
  79. <p>
  80. <code>xowa_upgrade</code> packages are produced with every release.
  81. </p>
  82. <h3>
  83. <span class="mw-headline" id="Upgrade_process">Upgrade process</span>
  84. </h3>
  85. <p>
  86. To upgrade, do the following:
  87. </p>
  88. <p>
  89. <b>Windows</b>
  90. </p>
  91. <ul>
  92. <li>
  93. Download the "xowa_upgrade" exe for your operating system. For example, if you're on Windows with a 64-bit JVM and upgrading to v2.8.2, you would download xowa_upgrade_windows_64_v2.8.2.1.exe
  94. </li>
  95. <li>
  96. Place the .exe in your xowa root directory. For example, if you're running XOWA by using <code>C:\xowa\xowa_64.exe</code>, then place xowa_upgrade_windows_64_v2.8.2.1.exe in <code>C:\xowa</code> so that the file name is <code>C:\xowa\xowa_upgrade_windows_64_v2.8.2.1.exe</code>
  97. </li>
  98. <li>
  99. Double-click the "xowa_upgrade.exe". The upgrade is a self-extracting 7-zip exe and will unzip all files and place them in the correct locations. Among other things, you'll have a new xowa.jar file. For example, <code>C:\xowa\xowa_windows_64.jar</code> should show a recent date.
  100. </li>
  101. </ul>
  102. <p>
  103. <b>Linux / Mac OS X</b>
  104. </p>
  105. <ul>
  106. <li>
  107. Download the "xowa_upgrade" zip for your operating system
  108. </li>
  109. <li>
  110. Place the .zip in your xowa root directory. For example, if you're running Mac OS X by using <code>/Users/your_user_name/xowa/xowa_macosx_64.sh</code>, then place xowa_upgrade_macosx_64_v2.8.2.1.zip in <code>/Users/your_user_name/xowa/</code> so that the file name is <code>/Users/your_user_name/xowa/xowa_upgrade_macosx_64_v2.8.2.1.zip</code>
  111. </li>
  112. <li>
  113. Extract the files. Note that depending on your unzip program, the file may be placed in a new sub-directory. For example, on Mac OS X, the files will be unzipped to a new folder called <code>/Users/your_user_name/xowa/xowa_upgrade_macosx_64_v2.8.2.1/</code>
  114. </li>
  115. <li>
  116. Move the files from the extracted folder to the XOWA root folder. Overwrite any files in the process. For example, on Mac OS X, there will be a new file called <code>/Users/your_user_name/xowa/xowa_upgrade_macosx_64_v2.8.2.1/xowa_macosx_64.jar</code>. This should be moved to <code>/Users/your_user_name/xowa/xowa_macosx_64.jar</code> and overwrite the existing version.
  117. </li>
  118. </ul>
  119. <h3>
  120. <span class="mw-headline" id="Upgrade_shelf-life_of_4_weeks">Upgrade shelf-life of 4 weeks</span>
  121. </h3>
  122. <p>
  123. A given upgrade will only work if your release is within the past 4 weeks. For example:
  124. </p>
  125. <ul>
  126. <li>
  127. You start off with the v2.1.3 application.
  128. </li>
  129. <li>
  130. v2.1.4 is released. You can use the v2.1.4 upgrade since your v2.1.3 release is 1 week old
  131. </li>
  132. <li>
  133. v2.2.1 is released and you haven't upgraded anything. You can use the v2.2.1 upgrade since your v2.1.3 release is 2 weeks old.
  134. </li>
  135. <li>
  136. v2.2.2 is released and you haven't upgraded anything. You can use the v2.2.2 upgrade since your v2.1.3 release is 3 weeks old.
  137. </li>
  138. <li>
  139. v2.2.3 is released and you haven't upgraded anything. You can use the v2.2.3 upgrade since your v2.1.3 release is 4 weeks old.
  140. </li>
  141. <li>
  142. v2.2.4 is released and you haven't upgraded anything. You can not use the v2.2.4 upgrade since your v2.1.3 release is 5 weeks old. You must get a new application package
  143. </li>
  144. </ul>
  145. <p>
  146. Once you upgrade, the 4-week window resets. You can perpetually upgrade XOWA in this fashion. For example:
  147. </p>
  148. <ul>
  149. <li>
  150. You start off with the v2.1.3 application.
  151. </li>
  152. <li>
  153. You upgrade when v2.2.3 is released. Your release will now be v2.2.3
  154. </li>
  155. <li>
  156. You upgrade again when v2.3.3 is released. Your release will now be v2.3.3
  157. </li>
  158. <li>
  159. You upgrade again when v2.4.1 is released. Your release will now be v2.4.1
  160. </li>
  161. <li>
  162. And so on...
  163. </li>
  164. </ul>
  165. <h3>
  166. <span class="mw-headline" id="Upgrade_issues_should_fallback_to_xowa_app_packages">Upgrade issues should fallback to xowa_app packages</span>
  167. </h3>
  168. <p>
  169. If you have problems after using an xowa_upgrade package, try upgrading using an xowa_app package. I personally test xowa_app packages on both Windows and Linux for every release and these will always work. In addition, due to the nature of the build script, the application package is always guaranteed to have the latest changes.
  170. </p>
  171. <h2>
  172. <span class="mw-headline" id="Upgrade_by_an_xowa_app_package">Upgrade by an xowa_app package</span>
  173. </h2>
  174. <p>
  175. You can also upgrade by downloading an xowa_app package and unzipping everything in the xowa root directory. For example:
  176. </p>
  177. <ul>
  178. <li>
  179. Download the "xowa_app" zip for your operating system
  180. </li>
  181. <li>
  182. Place the .zip in your xowa root directory. For example, if you're running on Windows 64-bit by using <code>C:\xowa\windows_64.exe</code>, then place xowa_app_windows_64_v2.8.2.1.zip in <code>C:\xowa\windows_64\</code> so that the file name is <code>C:\xowa\windows_64\xowa_app_windows_64_v2.8.2.1.zip</code>
  183. </li>
  184. <li>
  185. Extract the files. Note that depending on your unzip program, the file may be placed in a new sub-directory. For example, on Windows 64-bit, the files will be unzipped to a new folder called <code>C:\xowa\windows_64\xowa_app_windows_64_v2.8.2.1\</code>
  186. </li>
  187. <li>
  188. Move the files from the extracted folder to the XOWA root folder. Overwrite any files in the process. For example, on Windows 64-bit, there will be a new file called <code>C:\xowa\windows_64\xowa_app_windows_64_v2.8.2.1\xowa_windows_64.jar</code>. This should be moved to <code>C:\xowa\windows_64\xowa_windows_64.jar</code> and overwrite the existing version.
  189. </li>
  190. </ul>
  191. <p>
  192. Note that you can always just upgrade using the <code>xowa_app</code> package. The <code>xowa_upgrade</code> packages are provided because they are generally 5 to 10 times smaller than the application packages.
  193. </p>
  194. <h2>
  195. <span class="mw-headline" id="Upgrade_by_an_xowa_app_package_and_regenerating_the_XOWA_root_directory">Upgrade by an xowa_app package and regenerating the XOWA root directory</span>
  196. </h2>
  197. <p>
  198. You can also do an upgrade by renaming your existing XOWA root directory and unzipping a new app package in the same directory. For example, assuming a Windows system with XOWA in <code>C:\xowa</code>
  199. </p>
  200. <ul>
  201. <li>
  202. Rename the <code>C:\xowa</code> folder to <code>C:\xowa-old</code>
  203. </li>
  204. <li>
  205. Download an app package and unzip it to <code>C:\xowa</code>
  206. </li>
  207. <li>
  208. Move the following directories from <code>C:\xowa-old</code> to <code>C:\xowa</code>
  209. <ul>
  210. <li>
  211. <code>C:\xowa-old\wiki</code> to <code>C:\xowa\wiki</code>
  212. </li>
  213. <li>
  214. <code>C:\xowa-old\file</code> to <code>C:\xowa\file</code>
  215. </li>
  216. <li>
  217. <code>C:\xowa-old\user</code> to <code>C:\xowa\user</code>
  218. </li>
  219. </ul>
  220. </li>
  221. </ul>
  222. <p>
  223. This approach is more manual, but is meant as an alternate approach. It's also useful for moving XOWA from one drive to another.
  224. </p>
  225. <h2>
  226. <span class="mw-headline" id="In-app_updater">In-app updater</span>
  227. </h2>
  228. <p>
  229. XOWA also has an in-app updater. See <a href="/wiki/App/Setup/Update/In-app" id="xolnki_3" title="App/Setup/Update/In-app">the in-app help page</a>
  230. </p>
  231. </div>
  232. </div>
  233. </div>
  234. <div id="mw-head" class="noprint">
  235. <div id="left-navigation">
  236. <div id="p-namespaces" class="vectorTabs">
  237. <h3>Namespaces</h3>
  238. <ul>
  239. <li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
  240. </ul>
  241. </div>
  242. </div>
  243. </div>
  244. <div id='mw-panel' class='noprint'>
  245. <div id='p-logo'>
  246. <a style="background-image: url(https://gnosygnu.github.io/xowa/xowa_logo.png);" href="http://xowa.org/" title="Visit the main page"></a>
  247. </div>
  248. <div class="portal" id='xowa-portal-home'>
  249. <h3>XOWA</h3>
  250. <div class="body">
  251. <ul>
  252. <li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
  253. <li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
  254. <li><a href="https://www.youtube.com/watch?v=q0qbXYXEH6M" title="See a video of XOWA Desktop in action">Video</a></li>
  255. <li><a href="http://xowa.org/home/wiki/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
  256. <li><a href="http://xowa.org/home/wiki/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
  257. </ul>
  258. </div>
  259. </div>
  260. <div class="portal" id='xowa-portal-started'>
  261. <h3>Getting started</h3>
  262. <div class="body">
  263. <ul>
  264. <li><a href="http://xowa.org/home/wiki/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
  265. <li><a href="http://xowa.org/home/wiki/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
  266. <li><a href="http://xowa.org/home/wiki/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
  267. <li><a href="http://xowa.org/home/wiki/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
  268. <li><a href="http://xowa.org/home/wiki/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
  269. </ul>
  270. </div>
  271. </div>
  272. <div class="portal" id='xowa-portal-android'>
  273. <h3>Android</h3>
  274. <div class="body">
  275. <ul>
  276. <li><a href="http://xowa.org/home/wiki/Android/Setup.html" title='Setup XOWA on your Android device'>Setup</a></li>
  277. <li><a href="https://www.youtube.com/watch?v=jsMTBxGweUw" title="See a video of XOWA Android in action">Video</a></li>
  278. </ul>
  279. </div>
  280. </div>
  281. <div class="portal" id='xowa-portal-help'>
  282. <h3>Help</h3>
  283. <div class="body">
  284. <ul>
  285. <li><a href="http://xowa.org/home/wiki/Help/About.html" title='Get more information about XOWA'>About</a></li>
  286. <li><a href="http://xowa.org/home/wiki/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
  287. <li><a href="http://xowa.org/home/wiki/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
  288. <li><a href="http://xowa.org/home/wiki/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
  289. </ul>
  290. </div>
  291. </div>
  292. <div class="portal" id='xowa-portal-blog'>
  293. <h3>Blog</h3>
  294. <div class="body">
  295. <ul>
  296. <li><a href="http://xowa.org/home/wiki/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
  297. </ul>
  298. </div>
  299. </div>
  300. <div class="portal" id='xowa-portal-links'>
  301. <h3>Links</h3>
  302. <div class="body">
  303. <ul>
  304. <li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
  305. <li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
  306. <li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
  307. </ul>
  308. </div>
  309. </div>
  310. <div class="portal" id='xowa-portal-donate'>
  311. <h3>Donate</h3>
  312. <div class="body">
  313. <ul>
  314. <li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
  315. <li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
  316. <li><a href="http://xowa.org/home/wiki/Help/Donate.html" title="Support XOWA!">XOWA</a></li>
  317. </ul>
  318. </div>
  319. </div>
  320. </div>
  321. </body>
  322. </html>