jon48/webtrees-theme-rural

webtrees 的乡村主题

维护者

详情

github.com/jon48/webtrees-theme-rural

主页

源代码

问题

安装: 144

依赖: 0

建议者: 0

安全: 0

星标: 11

关注者: 4

分支: 2

开放问题: 7

语言:SCSS

类型:webtrees-theme

dev-main 2024-06-16 16:57 UTC

Requires (Dev)

GPL-3.0-or-later 22d7432b5b3e18d7fd1baa4d54429ba5003e173b

genealogywebtrees

This package is auto-updated.

Last update: 2024-09-16 17:39:40 UTC

README

Latest version Release date Downloads License

webtrees-theme-rural

webtrees 应用程序的 乡村主题

内容

许可

  • webtrees-theme-rural: webtrees 的乡村主题
  • 版权 (C) 2009 至 2024 Jonathan Jaubart。
  • 源自 webtrees - 版权 (C) 2010 至 2024 webtrees 开发团队。
  • 源自 PhpGedView - 版权 (C) 2002 至 2010 PGV 开发团队。

本程序是自由软件；您可以在自由软件基金会发布的 GNU 通用公共许可证的条款下重新分发和/或修改它；许可证的第 3 版，或者（根据您的选择）任何较新版本的许可证。

本程序以希望它对您有用为前提进行分发，但没有任何保证；甚至没有关于其适销性或适用于特定目的的隐含保证。有关详细信息，请参阅 GNU 通用公共许可证。

有关更详细的许可信息，请参阅随本软件一起提供的 LICENSE 文件。

简介

乡村主题最初于 2009 年为 PhpGedView 创建。此后，它已迁移到 webtrees，并跟随后续的演变，直至最新版本。最初嵌入在一个较大的代码库中，我在 2018 年将其提取到自己的 GitHub 仓库中。

乡村主题主要以棕色为主色调，作为对祖先曾经耕种的地球的致敬，辅以一些自然之绿的色彩。与其他使用全屏宽度的标准主题不同，其特色布局是以包裹在棕色背景上的响应式白色面板中的主要家谱内容为中心组织的。

页眉标志可以定制为任何图片，只要其高度不超过 150px（以下说明）。

多年来一直是我 webtrees 经历的忠实伴侣，我很高兴分享乡村主题，并希望它能进入您的主题列表。

Jonathan Jaubart

系统要求

webtrees-theme-rural 与标准 webtrees 安装具有相同的要求和系统配置。

仓库未实施任何浏览器兼容性测试，下表仅基于经验测试。如果您在支持的浏览器上遇到显示问题，请提出问题。

安装/升级

安装或升级过程遵循 webtrees 主题/模块的标准过程。

1.7 以前的版本

步骤

  1. 从 webtrees-theme-rural GitHub 仓库 下载与您的 webtrees 版本兼容的最新版本。
  2. 将存档解压缩到您的 webtrees 安装根目录下。zip 文件包含完整的文件夹结构，并将与您当前的文件夹合并。
  3. 检查 rural 文件夹是否现在位于 /themes/ 目录中。
  4. 打开 webtrees，Rural 主题现在应出现在主题列表中。

2.0 以后的版本

步骤

  1. 从 webtrees-theme-rural GitHub 仓库 下载与您的 webtrees 版本兼容的最新版本。
  2. 将存档解压缩到 /modules_v4/。
  3. 检查文件夹 myartjaub_ruraltheme 是否现在存在于 /modules_v4/ 目录中。
  4. 打开 webtrees，Rural 主题现在应出现在主题列表中。

定制

可以在页眉中更改默认的 webtrees 标志，并使用个人图片代替。我在自己的网站上使用自定义的页眉。在所有情况下，请确保个人图片的高度不超过 150px。

1.7 以前的版本

用个人图片替换 /themes/rural/css-1.7.8/images/header.png。

2.0 以后的版本

用个人图片替换 /modules_v4/myartjaub_ruraltheme/resources/images/header.png。

开发

Rural 主题基于 Bootstrap 框架，从版本 2.0 开始使用 Sass 编码样式表（先前的版本使用 Less）。生成样式表需要 Composer 和 npm。

如果您想贡献或创建自己的 Rural 主题版本，以下是一些建议（适用于 2.0 版本及以上）。

安装

将仓库克隆到您的本地机器。您可以选择在 /modules_v4/ 目录中直接创建目录，或者在其他地方创建它，并将 /modules_v4/myartjaub_ruraltheme 的符号链接到新创建的文件夹。

git clone https://github.com/jon48/webtrees-theme-rural.git target_directory

在目标目录中，首先安装 Composer 依赖项（以开发模式运行，以便生成样式表）。显式设置 fisharebest/webtrees 包使用源来生成样式表，不要更改此设置。

composer install

然后安装 node 依赖项（再次，以开发模式运行，以便生成样式表）

npm install

文件夹结构

|-- build/                        ->  Folder for intermediary build artefacts
|-- node_modules/                 ->  Node modules folder - do not alter
|-- resources/                    ->  Contains public resources, part of the final package 
|   |-- css/
|   |   |-- rural.min.js          ->  Rural Theme compiled stylesheet
|   |-- images/
|   |   |-- header.png            ->  Customisable header image
|   |-- views/
|       |-- footer.phtml          ->  HTML view to extend the footer with Rural images
|       |-- style.css.phtml       ->  Extra CSS stylesheet to load header image
|-- src/
|   |-- sass/                     ->  Sass code
|       |-- bootstrap/
|       |   |-- _pre-default.scss ->  Defines Bootstrap variable 
|       |   |-- config.scss       ->  Defines Bootstrap modules to generates
|       |-- resources/            ->  Resources used during Sass compilation
|       |   |-- images/           ->  Images are inlined in the compiled stylesheet
|       |-- rural/                ->  Rural Theme specific Sass code
|       |   |-- config.scss       ->  Rural Theme Sass entry point
|       |-- webtrees/
|       |   |-- config.scss       ->  Load specific mainstream webtrees CSS
|       |-- _variables.scss       ->  Defines global variables
|       |--theme.scss             ->  Sass entry point
|-- vendor/                       ->  Composer packages folder - do not alter
|-- module.php                    ->  Webtrees module entry point. Defines RuralTheme class.
|-- webpack.mix.config.js         ->  Global variables for Laravel Mix scripts
|-- webpack.mix.js                ->  Laravel Mix entry point
|-- webpack.mix.rural.js          ->  Lavarel Mix script to generate rural.min.css
|-- webpack.mix.webtrees.js       ->  Laravel Mix script to generate webtrees intermediary files

构建

在构建之前，请确保 fisharebest/webtrees 包位于正确的目标 webtrees 版本。

composer show fisharebest/webtrees

准备好生成样式表时，运行以下命令。

npm run production

让它编译，直到在 /modules_v4/myartjaub_ruraltheme/resources/css 文件夹中生成了 rural.min.css。

NPM 模式如下

  • production：以生产模式生成 rural.min.css 文件以及所有必需的文件。（运行下面的 webtrees 和 rural 模式，带有生产标志）
  • development：以开发模式生成 rural.min.css 文件以及所有必需的文件。（运行下面的 webtrees 和 rural 模式）
  • webtrees：从主流 webtrees 生成中间 CSS 到 /build/ 文件夹。这些中间文件随后注入到主 Rural 主题 CSS 中。这些文件需要在运行其他模式之前生成一次，或者通过 Composer 更新 webtrees 版本之后。 （Laravel Mix 入口点：webpack.mix.webtrees.js）
  • rural：以开发模式生成 rural.min.css 文件（未压缩）。需要先运行一次 webtrees 模式。（Laravel Mix 入口点：webpack.mix.rural.js）
  • watch：监视 SASS 代码中的更改，并在开发模式下生成 rural.min.css 文件。需要先运行一次 webtrees 模式。（Laravel Mix 入口点：webpack.mix.rural.js）
  • eslint / eslint-fix：分别检查并自动格式化 JavaScript 代码，以强制执行 Semi-Standard 代码风格
  • stylelint / stylelint-fix：分别检查并自动格式化 CSS & SASS 代码，以强制执行 StyleLint 代码风格

问题/安全

应在 webtrees-theme-rural 的 GitHub 仓库中提出问题。

已发布针对此仓库的 安全策略文档。

联系方式

有关标准 webtrees 软件的一般问题应发送到 官方论坛。

您可以通过作者（Jonathan Jaubart）的个人GeneaJaubart网站（页面底部链接）联系《webtrees-theme-rural》项目，或者在GitHub上提出问题。