UberGallery 技术文档

1. 安装指南

UberGallery 是一个简单易用的 PHP 照片画廊，下面是安装步骤：

1. 将 resources/sample.galleryConfig.ini 文件复制到 resources/galleryConfig.ini 并根据需要修改设置。

2. 将 index.php、resources/ 和 gallery-images/ 文件上传到您的 Web 服务器。

3. 将图片上传到 gallery-images/ 目录下。

4. 使 resources/cache/ 目录可被 Web 服务器写入：

   chmod 777 /path/to/resources/cache
   

5. 在浏览器中打开安装了 UberGallery 的页面。

2. 项目的使用说明

UberGallery 可以很容易地集成到现有网站中，以下是基本使用步骤：

1. 确保已经按照安装指南完成了安装步骤。

2. 在想要显示画廊的 PHP 页面中插入以下代码，记得将路径修改为您的配置：

   <?php include_once('path/to/resources/UberGallery.php'); $gallery = UberGallery::init()->createGallery('path/to/images-folder'); ?>
   

3. 在页面头部包含 UberGallery 和 ColorBox 样式表：

   <link rel="stylesheet" type="text/css" href="path/to/resources/UberGallery.css" />
   <link rel="stylesheet" type="text/css" href="path/to/resources/colorbox/1/colorbox.css" />
   

   注意：你可以将 1 替换为 1 到 5 之间的值以使用不同的 ColorBox 主题。

4. 在页面头部包含 jQuery 和 ColorBox JavaScript 文件：

   <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
   <script type="text/javascript" src="path/to/resources/colorbox/jquery.colorbox.js"></script>
   

5. 在头部包含 ColorBox jQuery 调用：

   <script type="text/javascript">
   $(document).ready(function(){
       $("a[rel='colorbox']").colorbox({maxWidth: "90%", maxHeight: "90%", opacity: ".5"});
   });
   </script>
   

6. 上传图片到你的图片目录。

7. 确保 resources/cache/ 目录可写。

3. 项目API使用文档

UberGallery 提供了一个简单的 API 用于创建和定制画廊。以下是一个基本示例：

<?php
include_once('path/to/resources/UberGallery.php');
$gallery = UberGallery::init()->createGallery('path/to/images-folder');
?>

你可以通过修改 galleryConfig.ini 文件中的设置来自定义画廊。

4. 项目安装方式

除了基本的安装方式，UberGallery 还可以通过 Git 进行安装：

1. 通过 SSH 连接到服务器并克隆 UberGallery 仓库及其子模块：

   git clone --recursive git://github.com/UberGallery/UberGallery.git /path/to/ubergallery
   

2. 将 resources/sample.galleryConfig.ini 复制到 resources/galleryConfig.ini 并进行修改：

   cp resources/sample.galleryConfig.ini resources/galleryConfig.ini
   nano resources/galleryConfig.ini
   

3. 将图片上传到画廊目录中的 gallery-images/ 文件夹。

4. 确保 resources/cache/ 目录可写。

5. 在浏览器中打开安装了 UberGallery 的页面。

通过 Git 安装 UberGallery 后，可以通过以下命令更新安装：

cd /path/to/gallery-directory
git pull origin master
git submodule update

如果将 UberGallery 作为子模块添加到现有的 Git 仓库中，需要执行以下操作：

git submodule add git://github.com/UberGallery/UberGallery.git path/to/ubergallery
git submodule update --init --recursive path/to/ubergallery