readme.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   3 <head>  \r
   4         <meta http-equiv="content-type" content="text/html; charset=utf-8" />\r
   5         <title>YOURLS: Your Own URL Shortener Readme</title>\r
   6         <style type="text/css" media="screen">\r
   7                 /* Default Style */\r
   8                 BODY {\r
   9                         font-family: Verdana, Arial;\r
  10                         font-size: 12px;\r
  11                         color: #000000;\r
  12                         background: #FFFFFF;\r
  13                 }\r
  14                 P {\r
  15                         padding-left: 10px;\r
  16                 }\r
  17                 BLOCKQUOTE {\r
  18                         margin: 10px 20px 0px 20px;\r
  19                         padding: 10px;\r
  20                         border: 1px solid #8d8d8d;\r
  21                         background-color: #f5f5f5;\r
  22                 }\r
  23                 LI {\r
  24                         margin-top: 20px;\r
  25                 }\r
  26                 UL LI UL LI {\r
  27                         margin-top: 10px;\r
  28                 }\r
  29                 A, A:active, A:link, A:visited {\r
  30                         color: #2d3a4c;\r
  31                         text-decoration: none;\r
  32                 }\r
  33                 A:hover {\r
  34                         color: #5577a5;\r
  35                         text-decoration: underline;\r
  36                 }\r
  37                 /* Place Holder Style */\r
  38                 #Container {\r
  39                         width: 780px;\r
  40                         margin-left: auto;\r
  41                         margin-right: auto; \r
  42                 }\r
  43                 #Content {\r
  44                         background-color: #fafafa;\r
  45                         border: 1px solid #a2b6cb;\r
  46                         padding: 10px;\r
  47                         margin-top: -13px;\r
  48                 }\r
  49                 /* Title Style */\r
  50                 #Title {\r
  51                         font-family: Verdana, Arial;\r
  52                         font-size: 22px;\r
  53                         font-weight: bold;\r
  54                         color: #389aff;\r
  55                         border-bottom: 1px solid #389aff;\r
  56                         margin-bottom: 10px;\r
  57                 }\r
  58                 .SubTitle {\r
  59                         font-family: Verdana, Arial;\r
  60                         font-size: 18px;\r
  61                         font-weight: bold;\r
  62                         color: #5b87b4;\r
  63                 }\r
  64                 .SubSubTitle {\r
  65                         font-family: Verdana, Arial;\r
  66                         font-size: 14px;\r
  67                         font-weight: bold;\r
  68                         color: #73a4d6;\r
  69                 }\r
  70                 /* Tabs */\r
  71                 UL#Tabs {\r
  72                         font-family: Verdana, Arial;\r
  73                         font-size: 12px;\r
  74                         font-weight: bold;\r
  75                         list-style-type: none;\r
  76                         padding-bottom: 28px;\r
  77                         border-bottom: 1px solid #a2b6cb;\r
  78                         margin-bottom: 12px;\r
  79                         z-index: 1;\r
  80                 }\r
  81                 #Tabs LI.Tab {\r
  82                         float: right;\r
  83                         height: 25px;\r
  84                         background-color: #deedfb;\r
  85                         margin: 2px 0px 0px 5px;\r
  86                         border: 1px solid #a2b6cb;\r
  87                 }\r
  88                 #Tabs LI.Tab A {\r
  89                         float: left;\r
  90                         display: block;\r
  91                         color: #666666;\r
  92                         text-decoration: none;\r
  93                         padding: 5px;\r
  94                 }\r
  95                 #Tabs LI.Tab A:hover {\r
  96                         background-color: #bfe0fe;\r
  97                         border-bottom: 1px solid #bfe0fe;\r
  98                 }\r
  99                 /* Selected Tab */\r
 100                 #Tabs LI.SelectedTab {\r
 101                         float: right;\r
 102                         height: 25px;\r
 103                         background-color: #fafafa;\r
 104                         margin: 2px 0px 0px 5px;\r
 105                         border-top: 1px solid #a2b6cb;\r
 106                         border-right: 1px solid #a2b6cb;\r
 107                         border-bottom: 1px solid #fafafa;\r
 108                         border-left: 1px solid #a2b6cb;\r
 109                 }\r
 110                 #Tabs LI.SelectedTab A {\r
 111                         float: left;\r
 112                         display: block;\r
 113                         color: #666666;\r
 114                         text-decoration: none;\r
 115                         padding: 5px;\r
 116                         cursor: default;\r
 117                 }\r
 118                 /* Copyright */\r
 119                 #Copyright {\r
 120                         text-align: center;\r
 121                 }\r
 122         </style>\r
 123         <script type="text/javascript">\r
 124         /* <![CDATA[*/\r
 125                 // Index Page\r
 126                 function index() {\r
 127                         // Tab\r
 128                         document.getElementById('IndexTab').className = 'SelectedTab';\r
 129                         document.getElementById('ChangelogTab').className = 'Tab';\r
 130                         document.getElementById('InstallTab').className = 'Tab';\r
 131                         document.getElementById('ConfigTab').className = 'Tab';\r
 132                         document.getElementById('FAQTab').className = 'Tab';\r
 133                         // Page\r
 134                         document.getElementById('Index').style.display= 'block';\r
 135                         document.getElementById('Changelog').style.display = 'none';\r
 136                         document.getElementById('Install').style.display = 'none';\r
 137                         document.getElementById('Config').style.display = 'none';\r
 138                         document.getElementById('Faq').style.display = 'none';\r
 139                 }\r
 140                 // Changelog Page\r
 141                 function changelog() {\r
 142                         // Tab\r
 143                         document.getElementById('IndexTab').className = 'Tab';\r
 144                         document.getElementById('ChangelogTab').className = 'SelectedTab';\r
 145                         document.getElementById('InstallTab').className = 'Tab';\r
 146                         document.getElementById('ConfigTab').className = 'Tab';\r
 147                         document.getElementById('FAQTab').className = 'Tab';\r
 148                         // Page\r
 149                         document.getElementById('Index').style.display = 'none';\r
 150                         document.getElementById('Changelog').style.display = 'block';\r
 151                         document.getElementById('Install').style.display = 'none';\r
 152                         document.getElementById('Config').style.display = 'none';\r
 153                         document.getElementById('Faq').style.display = 'none';\r
 154                 }\r
 155                 // Installation Page\r
 156                 function install() {\r
 157                         // Tab\r
 158                         document.getElementById('IndexTab').className = 'Tab';\r
 159                         document.getElementById('ChangelogTab').className = 'Tab';\r
 160                         document.getElementById('InstallTab').className = 'SelectedTab';\r
 161                         document.getElementById('ConfigTab').className = 'Tab';\r
 162                         document.getElementById('FAQTab').className = 'Tab';\r
 163                         // Page\r
 164                         document.getElementById('Index').style.display= 'none';\r
 165                         document.getElementById('Changelog').style.display = 'none';\r
 166                         document.getElementById('Install').style.display = 'block';\r
 167                         document.getElementById('Config').style.display = 'none';\r
 168                         document.getElementById('Faq').style.display = 'none';\r
 169                 }\r
 170                 // Config Page\r
 171                 function config() {\r
 172                         // Tab\r
 173                         document.getElementById('IndexTab').className = 'Tab';\r
 174                         document.getElementById('ChangelogTab').className = 'Tab';\r
 175                         document.getElementById('InstallTab').className = 'Tab';\r
 176                         document.getElementById('ConfigTab').className = 'SelectedTab';\r
 177                         document.getElementById('FAQTab').className = 'Tab';\r
 178                         // Page\r
 179                         document.getElementById('Index').style.display= 'none';\r
 180                         document.getElementById('Changelog').style.display = 'none';\r
 181                         document.getElementById('Install').style.display = 'none';\r
 182                         document.getElementById('Config').style.display = 'block';\r
 183                         document.getElementById('Faq').style.display = 'none';\r
 184                 }\r
 185                 // FAQ Page\r
 186                 function faq() {\r
 187                         // Tab\r
 188                         document.getElementById('IndexTab').className = 'Tab';\r
 189                         document.getElementById('ChangelogTab').className = 'Tab';\r
 190                         document.getElementById('InstallTab').className = 'Tab';\r
 191                         document.getElementById('ConfigTab').className = 'Tab';\r
 192                         document.getElementById('FAQTab').className = 'SelectedTab';\r
 193                         // Page\r
 194                         document.getElementById('Index').style.display= 'none';\r
 195                         document.getElementById('Changelog').style.display = 'none';\r
 196                         document.getElementById('Install').style.display = 'none';\r
 197                         document.getElementById('Config').style.display = 'none';\r
 198                         document.getElementById('Faq').style.display = 'block';\r
 199                 }\r
 200         /* ]]> */\r
 201         </script>\r
 202 </head>\r
 203 <body>\r
 204 <div id="Container">\r
 205         <!-- Title -->\r
 206         <div id="Title">YOURLS: Your Own URL Shortener&nbsp;&nbsp;&nbsp;<span style="color: #aaaaaa;">Readme</span></div>\r
 207 \r
 208         <!-- Tabs -->\r
 209         <ul id="Tabs">\r
 210                 <li id="FAQTab" class="Tab"><a href="#Usage" onclick="faq(); return false;" title="Usage Instructions">FAQ</a></li>\r
 211                 <li id="ConfigTab" class="Tab"><a href="#Upgrade" onclick="config(); return false;" title="Upgrade Instructions">Configuration</a></li>\r
 212                 <li id="InstallTab" class="Tab"><a href="#Installation" onclick="install(); return false;" title="Installation Instructions">Installation</a></li>\r
 213                 <li id="ChangelogTab" class="Tab"><a href="#Changelog" onclick="changelog(); return false;" title="Changelog">Changelog</a></li>\r
 214                 <li id="IndexTab" class="SelectedTab"><a href="#Index" onclick="index(); return false;" title="Index Instructions">Index</a></li>\r
 215         </ul>\r
 216 \r
 217         <!-- Content -->\r
 218         <div id="Content">\r
 219                 <!-- Index -->\r
 220                 <div id="Index">\r
 221                         <div class="SubTitle">&raquo; Index</div>\r
 222                         <div class="SubSubTitle">Plugin Information</div>\r
 223                         <p>\r
 224                                 <strong>Author:</strong><br />\r
 225                                 <strong>&raquo;</strong> Richard Ozh, Lester Chan\r
 226                         </p>\r
 227                         <p>\r
 228                                 <strong>Website:</strong><br /><strong>&raquo;</strong> <a href="http://planetozh.com/" title="http://planetozh.com/">http://planetozh.com/</a>, <a href="http://lesterchan.net/" title="http://lesterchan.net/">http://lesterchan.net/</a>\r
 229                         </p>\r
 230                         <p>\r
 231                                 <strong>Features:</strong><br />\r
 232                                 <strong>&raquo;</strong> YOURLS is a PHP script that will allow you to run your own URL shortener, a la TinyURL. You can make it private or public, and a WordPress plugin makes integration with your WordPress blog a snap.\r
 233                         </p>\r
 234                         <p>\r
 235                                 <strong>Download:</strong><br />\r
 236                                 <strong>&raquo;</strong> <a href="http://code.google.com/p/yourls/downloads/list" title="http://code.google.com/p/yourls/downloads/list">YOURLS 1.0.0 Beta 1</a><br />\r
 237                         </p>\r
 238                         <p>\r
 239                                 <strong>Demo:</strong><br /><strong>&raquo;</strong> <a href="http://yourls.org" title="http://yourls.org">yourls.org</a>, <a href="http://lc.sg" title="http://lc.sg">lc.sg</a>, <a href="http://ozh.in" title="http://ozh.in">ozh.in</a>\r
 240                         </p>\r
 241                         <p>\r
 242                                 <strong>Development:</strong><br />\r
 243                                 <strong>&raquo;</strong> <a href="http://code.google.com/p/yourls/" title="http://code.google.com/p/yourls/">http://code.google.com/p/yourls/</a>\r
 244                         </p>\r
 245                         <p>\r
 246                                 <strong>Bugs Reporting:</strong><br />\r
 247                                 <strong>&raquo;</strong> <a href="http://code.google.com/p/yourls/issues/list" title="http://code.google.com/p/yourls/issues/list">http://code.google.com/p/yourls/issues/list</a>\r
 248                         </p>\r
 249                         <p>\r
 250                                 <strong>Credits:</strong><br />\r
 251                                 <strong>&raquo;</strong> Blah Blah\r
 252                         </p>\r
 253                         <p>\r
 254                                 <strong>Note:</strong><br />\r
 255                                 <strong>&raquo;</strong> The <strong>Changelog</strong>, <strong>Installation</strong>, <strong>Upgrade</strong>, <strong>Usage</strong> Tab at the top of the page.\r
 256                         </p>\r
 257                 </div>\r
 258 \r
 259                 <!-- Changelog -->\r
 260                 <div id="Changelog" style="display: none;">\r
 261                         <div class="SubTitle">Changelog</div>\r
 262                         <ul>\r
 263                                 <li>\r
 264                                         <strong>Version 1.0.0 (01-07-2009)</strong>\r
 265                                         <ul>\r
 266                                                 <li>NEW: Initial Release</li>\r
 267                                         </ul>\r
 268                                 </li>\r
 269                         </ul>\r
 270                 </div>\r
 271 \r
 272                 <!-- Installation Instructions -->\r
 273                 <div id="Install" style="display: none;">\r
 274                         <div class="SubTitle">&raquo; Installation Instructions</div>\r
 275                         <ol>\r
 276                                 <li>\r
 277                                         Unzip <strong>yourls1.0.0.zip</strong>\r
 278                                 </li>\r
 279                                 <li>\r
 280                                         Rename includes/config-sample.php to <strong>includes/config.php</strong>\r
 281                                 </li>\r
 282                                 <li>\r
 283                                         Open up <strong>includes/config.php</strong> and fill in the required settings\r
 284                                 </li>\r
 285                                 <li>\r
 286                                          Upload the unzipped files to your domain <strong>public_html</strong> or <strong>www</strong> folder\r
 287                                 </li>\r
 288                                 <li>\r
 289                                         Point your browser to <strong>http://yoursite.com/install.php</strong>\r
 290                                 </li>\r
 291                         </ol>\r
 292                 </div>\r
 293 \r
 294                 <!-- Configuration Instructions -->     \r
 295                 <div id="Config" style="display: none;">\r
 296                         <div class="SubTitle">&raquo; Configuration</div>\r
 297                         <div class="SubSubTitle">In includes/config.php</div>\r
 298                         <ol>\r
 299                                 <li>\r
 300                                         <strong>YOURLS_DB_USER</strong>\r
 301                                 </li>\r
 302                                 <li>\r
 303                                         <strong>YOURLS_DB_PASS</strong>\r
 304                                 </li>\r
 305                                 <li>\r
 306                                         <strong>YOURLS_DB_NAME</strong>\r
 307                                 </li>\r
 308                                 <li>\r
 309                                         <strong>YOURLS_DB_HOST</strong>\r
 310                                 </li>\r
 311                                 <li>\r
 312                                         <strong>YOURLS_DB_TABLE_URL</strong>\r
 313                                 </li>\r
 314                                 <li>\r
 315                                         <strong>YOURLS_DB_TABLE_NEXTDEC</strong>\r
 316                                 </li>\r
 317                                 <li>\r
 318                                         <strong>YOURLS_SITE</strong>\r
 319                                 </li>\r
 320                                 <li>\r
 321                                         <strong>YOURLS_HOURS_OFFSET</strong>\r
 322                                 </li>\r
 323                                 <li>\r
 324                                         <strong>YOURLS_PRIVATE</strong>\r
 325                                 </li>\r
 326                                 <li>\r
 327                                         <strong>YOURLS_PRIVATE</strong>\r
 328                                 </li>\r
 329                         </ol>\r
 330                 </div>\r
 331 \r
 332                 <!-- FAQ Instructions -->       \r
 333                 <div id="Faq" style="display: none;">\r
 334                         <div class="SubTitle">&raquo; FAQ</div>\r
 335                         <div class="SubSubTitle">Requirements</div>\r
 336                         <ol>\r
 337                                 <li>At least PHP 4.3</li>\r
 338                                 <li>At least MYSQL 4.1</li>\r
 339                                 <li>PHP <a href="http://www.php.net/curl" title="http://www.php.net/curl">CURL extension</a> installed</li>\r
 340                                 <li>PHP <a href="http://www.php.net/bccomp" title="http://www.php.net/bccomp">BCCOMP extension</a> for handling large integers</li>     \r
 341                         </ol>\r
 342                         <div class="SubSubTitle">Limitations</div>\r
 343                         <ol>\r
 344                                 <li>Maximum length of custom keyword is <strong>12 characters</strong></li>\r
 345                                 <li><strong>4,738,381,338,321,617,846</strong> available URLs</li>\r
 346                         </ol>\r
 347                         <div class="SubSubTitle">Difference Between Base 36 And Vase 62 Encoding</div>\r
 348                         <ol>\r
 349                                 <li>Base 36 encoding uses 0123456789abcdefghijklmnopqrstuvwxyz</li>\r
 350                                 <li>Base 62 encoding uses 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz</li>\r
 351                         </ol>\r
 352                 </div>\r
 353         </div>\r
 354 </div>\r
 355 <p id="Copyright">YOURLS: Your Own URL Shortener<br />Copyright &copy; 2009 YOURLS. All Rights Reserved.</p>\r
 356 </body>\r
 357 </html>