Site_config.html 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. <!DOCTYPE html>
  2. <html dir="ltr">
  3. <head>
  4. <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
  5. <title>Dev/Design/Site config - 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>Dev/Design/Site config</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. <h2>
  19. <span class="mw-headline" id="Sample_files">Sample files</span>
  20. </h2>
  21. <p>
  22. In /xowa/bin/any/xowa/cfg/wiki/api/, each folder has a sample file that can be used for a wiki. To use it do the following:
  23. </p>
  24. <ul>
  25. <li>
  26. Copy the "-sample.csv" file
  27. </li>
  28. <li>
  29. Replace the "-sample" to the name of the wiki. For example, for nethackwiki.com, rename the file to "extensiontags-nethackwiki.com.csv". For English Wikipedia, use "extensiontags-en.wikipedia.org.csv"
  30. </li>
  31. <li>
  32. Import the wiki. XOWA will use the data in the file when creating the wiki
  33. </li>
  34. </ul>
  35. <p>
  36. This data gets stored in the main ".xowa" database in the xowa_cfg table. For example, run the following SQL: SELECT * FROM xowa_cfg WHERE cfg_key = 'extensiontags';
  37. </p>
  38. <p>
  39. The remainder of this article documents the purpose of each file.
  40. </p>
  41. <h2>
  42. <span class="mw-headline" id="extensiontags">extensiontags</span>
  43. </h2>
  44. <p>
  45. The "extensiontags" file lists active extensions. For example, to enable only &lt;ref&gt; and &lt;references&gt;, use the following two lines:
  46. </p>
  47. <pre>
  48. ref
  49. references
  50. </pre>
  51. <p>
  52. All other extension tags will be disabled. For example, &lt;math&gt; will show up as just &lt;math&gt; LaTeX source instead of being replaced with graphical equations
  53. </p>
  54. <p>
  55. The main purpose of this functionality is to disable extensions in some wikis. For example, the &lt;do&gt; extension is only active in the Wikivoyage wiki. Otherwise, English Wikipedia has an article called <a href="https://en.wikipedia.org/wiki/Type_system" rel="nofollow" class="external text">Type system</a> which will render incorrectly with the following fragment:
  56. </p>
  57. <pre>
  58. &lt;code&gt;if &lt;complex test&gt; then &lt;do something&gt; else &lt;generate type error&gt;&lt;/code&gt;
  59. </pre>
  60. <h2>
  61. <span class="mw-headline" id="interwikimap">interwikimap</span>
  62. </h2>
  63. <p>
  64. The "interwikimap" file lists active interwiki prefixes. For example, to enable only the interwiki prefix for commons, use the following:
  65. </p>
  66. <pre>
  67. commons|https://commons.wikimedia.org/wiki/~{0}
  68. </pre>
  69. <p>
  70. This will convert [[commons:Earth]] to a link to <a href="https://commons.wikipedia.org/wiki/Earth" rel="nofollow" class="external free">https://commons.wikipedia.org/wiki/Earth</a>
  71. </p>
  72. </div>
  73. </div>
  74. </div>
  75. <div id="mw-head" class="noprint">
  76. <div id="left-navigation">
  77. <div id="p-namespaces" class="vectorTabs">
  78. <h3>Namespaces</h3>
  79. <ul>
  80. <li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
  81. </ul>
  82. </div>
  83. </div>
  84. </div>
  85. <div id='mw-panel' class='noprint'>
  86. <div id='p-logo'>
  87. <a style="background-image: url(https://gnosygnu.github.io/xowa/xowa_logo.png);" href="http://xowa.org/" title="Visit the main page"></a>
  88. </div>
  89. <div class="portal" id='xowa-portal-home'>
  90. <h3>XOWA</h3>
  91. <div class="body">
  92. <ul>
  93. <li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
  94. <li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
  95. <li><a href="https://www.youtube.com/watch?v=q0qbXYXEH6M" title="See a video of XOWA Desktop in action">Video</a></li>
  96. <li><a href="http://xowa.org/home/wiki/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
  97. <li><a href="http://xowa.org/home/wiki/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
  98. </ul>
  99. </div>
  100. </div>
  101. <div class="portal" id='xowa-portal-started'>
  102. <h3>Getting started</h3>
  103. <div class="body">
  104. <ul>
  105. <li><a href="http://xowa.org/home/wiki/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
  106. <li><a href="http://xowa.org/home/wiki/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
  107. <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>
  108. <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>
  109. <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>
  110. </ul>
  111. </div>
  112. </div>
  113. <div class="portal" id='xowa-portal-android'>
  114. <h3>Android</h3>
  115. <div class="body">
  116. <ul>
  117. <li><a href="http://xowa.org/home/wiki/Android/Setup.html" title='Setup XOWA on your Android device'>Setup</a></li>
  118. <li><a href="https://www.youtube.com/watch?v=jsMTBxGweUw" title="See a video of XOWA Android in action">Video</a></li>
  119. </ul>
  120. </div>
  121. </div>
  122. <div class="portal" id='xowa-portal-help'>
  123. <h3>Help</h3>
  124. <div class="body">
  125. <ul>
  126. <li><a href="http://xowa.org/home/wiki/Help/About.html" title='Get more information about XOWA'>About</a></li>
  127. <li><a href="http://xowa.org/home/wiki/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
  128. <li><a href="http://xowa.org/home/wiki/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
  129. <li><a href="http://xowa.org/home/wiki/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
  130. </ul>
  131. </div>
  132. </div>
  133. <div class="portal" id='xowa-portal-blog'>
  134. <h3>Blog</h3>
  135. <div class="body">
  136. <ul>
  137. <li><a href="http://xowa.org/home/wiki/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
  138. </ul>
  139. </div>
  140. </div>
  141. <div class="portal" id='xowa-portal-links'>
  142. <h3>Links</h3>
  143. <div class="body">
  144. <ul>
  145. <li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
  146. <li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
  147. <li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
  148. </ul>
  149. </div>
  150. </div>
  151. <div class="portal" id='xowa-portal-donate'>
  152. <h3>Donate</h3>
  153. <div class="body">
  154. <ul>
  155. <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/ -->
  156. <li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
  157. <li><a href="http://xowa.org/home/wiki/Help/Donate.html" title="Support XOWA!">XOWA</a></li>
  158. </ul>
  159. </div>
  160. </div>
  161. </div>
  162. </body>
  163. </html>