buepro/typo3-user-pizpalue

使用模板pizpalue的TYPO3站点包。

安装次数: 1,158

依赖: 3

建议者: 0

安全: 0

星标: 3

关注者: 3

分支: 0

开放问题: 0

类型:typo3-cms-extension

v6.0.1 2024-02-09 10:02 UTC

README

TYPO3 12 TYPO3 13 Extension pizpalue Total Downloads Monthly Downloads

此扩展作为站点包,用于自定义使用模板pizpalue的TYPO3网站,版本15.0.0及以上。

安装

以下步骤使用此包作为composer根包设置TYPO3网站。

  1. 获取源代码

    composer create-project buepro/typo3-user-pizpalue && cd typo3-user-pizpalue && composer u
    
  2. 设置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" \
    
  3. 设置扩展

    .build/bin/typo3 extension:setup
    composer rem buepro/typo3-pizpalue-distribution
    

    注意:由于页面树和资源已通过设置扩展加载,我们删除了分发。

  4. 复制 htaccess

    cp .build/vendor/typo3/cms-install/Resources/Private/FolderStructureTemplateFiles/root-htaccess .build/public/.htaccess
    
  5. 审查 composer.json

    1. 定义包

      删除网站不需要的包的依赖。

      注意:仅使用所需的包。在许多项目中只需buepro/typo3-pizpaluebuepro/typo3-container-elements

    2. 检查PHP配置

      确保在shell和cron作业中使用的PHP版本与运行网站时使用的PHP版本相对应。如果它们不同,您可能需要在composer.json中添加平台配置。一个可能的平台配置可能如下所示

      "config": {
        "platform": {
          "php": "8.2.6"
        }
      }
      
  6. 完成安装

    .build/bin/typo3 cache:warmup
    

使用方法

当开始一个新项目时,创建一个新的git分支并仅提交到该分支。主分支应始终用于开始新项目。

为了提高工作效率,可以提交和记录工作进度。文档位于Documentation文件夹中。可以通过以下步骤创建变更日志

  1. 在shell中进入Build目录
  2. 运行npm install(如果尚未执行,则需要运行)
  3. 运行grunt doc

自定义

TypoScript (TS)

自定义通常从调整ts constantsts setup开始。常用的配置收集在Configuration/TypoScript/Sample文件夹中。您可以通过将所需的片段复制到Configuration/TypoScript/constants.typoscriptConfiguration/TypoScript/setup.typoscript中来开始使用它们。

CSS/SCSS

样式声明存储在Resources/Public/Scss文件夹中。要嵌入样式表,需要设置TS。有关详细信息,请参阅page.includeCSS

图标字体

创建自定义图标字体可能很有用。理想情况下,它包含网站中使用的所有图标。要生成图标字体,图标需要以svg格式提供。遗憾的是,并非所有svg格式都能产生预期结果,因此可能需要进行一些测试。可以通过以下步骤创建图标字体

  1. 将所有svg图标复制到文件夹Resources/Public/Icons/Font
  2. 在shell中进入Build目录
  3. 运行npm install(如果尚未执行,则需要运行)
  4. 运行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 中。以下是一个添加新页面模板的示例步骤

  1. 在目录 Resources/Private/Templates/Page 中创建模板
  2. 在 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 { ... }

常用

编码

用于文档