buepro / typo3-user-pizpalue
使用模板pizpalue的TYPO3站点包。
Requires
- buepro/typo3-container-elements: ^5.0.0
- buepro/typo3-easyconf: ^2.0.0
- buepro/typo3-pizpalue: ^16.0.0
- buepro/typo3-pizpalue-distribution: ^7.0.1@dev
- friendsoftypo3/tt-address: ^8.0.1
- georgringer/news: ^11.0.0
- typo3/cms-base-distribution: ^12.4
- typo3/cms-core: 12.4.9
- typo3/cms-indexed-search: ^12.4
- typo3/cms-lowlevel: ^12.4
- typo3/cms-recycler: ^12.4
- typo3/cms-redirects: ^12.4
README
此扩展作为站点包,用于自定义使用模板pizpalue的TYPO3网站,版本15.0.0及以上。
安装
以下步骤使用此包作为composer根包设置TYPO3网站。
-
获取源代码
composer create-project buepro/typo3-user-pizpalue && cd typo3-user-pizpalue && composer u
-
设置TYPO3
.build/bin/typo3 setup \ --no-interaction \ --driver=mysqli \ --host=db \ --port=3306 \ --dbname=db \ --username=db \ --password=db \ --admin-username=admin \ --admin-user-password=password \ --admin-email='' \ --project-name="Pizpalue site" \
-
设置扩展
.build/bin/typo3 extension:setup composer rem buepro/typo3-pizpalue-distribution
注意:由于页面树和资源已通过设置扩展加载,我们删除了分发。
-
复制
htaccess
cp .build/vendor/typo3/cms-install/Resources/Private/FolderStructureTemplateFiles/root-htaccess .build/public/.htaccess
-
审查
composer.json
-
定义包
删除网站不需要的包的依赖。
注意:仅使用所需的包。在许多项目中只需
buepro/typo3-pizpalue
和buepro/typo3-container-elements
。 -
检查PHP配置
确保在shell和cron作业中使用的PHP版本与运行网站时使用的PHP版本相对应。如果它们不同,您可能需要在
composer.json
中添加平台配置。一个可能的平台配置可能如下所示"config": { "platform": { "php": "8.2.6" } }
-
-
完成安装
.build/bin/typo3 cache:warmup
使用方法
当开始一个新项目时,创建一个新的git分支并仅提交到该分支。主分支应始终用于开始新项目。
为了提高工作效率,可以提交和记录工作进度。文档位于Documentation
文件夹中。可以通过以下步骤创建变更日志
- 在shell中进入
Build
目录 - 运行
npm install
(如果尚未执行,则需要运行) - 运行
grunt doc
自定义
TypoScript (TS)
自定义通常从调整ts constants和ts setup开始。常用的配置收集在Configuration/TypoScript/Sample
文件夹中。您可以通过将所需的片段复制到Configuration/TypoScript/constants.typoscript
或Configuration/TypoScript/setup.typoscript
中来开始使用它们。
CSS/SCSS
样式声明存储在Resources/Public/Scss
文件夹中。要嵌入样式表,需要设置TS。有关详细信息,请参阅page.includeCSS
。
图标字体
创建自定义图标字体可能很有用。理想情况下,它包含网站中使用的所有图标。要生成图标字体,图标需要以svg格式提供。遗憾的是,并非所有svg格式都能产生预期结果,因此可能需要进行一些测试。可以通过以下步骤创建图标字体
- 将所有svg图标复制到文件夹
Resources/Public/Icons/Font
- 在shell中进入
Build
目录 - 运行
npm install
(如果尚未执行,则需要运行) - 运行
grunt iconfont
在创建图标字体后,其资源可以在 Resources/Public/Fonts
中找到。接下来,需要使用以下 TS 设置将字体嵌入:
page {
includeCSSLibs {
pizpalueicon >
upicon = EXT:user_pizpalue/Resources/Public/Fonts/upicon.min.css
}
}
现在您可以在标记中使用图标字体了: <i class="upicon upicon-custom1"></i>
将渲染一个显示由 custom1.svg
定义的图形的图标。
布局/模板/部分
它们维护在 Resources/Private
中。以下是一个添加新页面模板的示例步骤
- 在目录
Resources/Private/Templates/Page
中创建模板 - 在 TS 常量声明中启用模板
page {
fluidtemplate {
templateRootPath = EXT:user_pizpalue/Resources/Private/Templates/Page/
}
}
开发
- 测试代码:
ddev composer ci
- 修复代码:
ddev composer fix
编码指南
- 使用 TYPO3 定义的 编码指南。
- 在包相关的前缀中使用 up, Up, up-, upc-,其中
upc-
主要用于与其他选择器一起使用的辅助 CSS 类(例如.up-example .upc-red { ... }
)
常用
编码
用于文档