Discourse Advertising Plugin 安装与使用指南

Discourse Advertising Plugin 安装与使用指南

discourse-adpluginOfficial Discourse Advertising Plugin. Install & Start Serving Ads on Your Discourse Forum项目地址:https://gitcode.com/gh_mirrors/di/discourse-adplugin

1. 项目的目录结构及介绍

Discourse Advertising Plugin 的目录结构如下：

discourse-adplugin/
├── app/
│   ├── assets/
│   ├── controllers/
│   ├── helpers/
│   ├── models/
│   └── views/
├── config/
│   ├── locales/
│   └── settings.yml
├── db/
│   └── migrate/
├── lib/
│   ├── discourse_adplugin/
│   └── tasks/
├── spec/
│   ├── controllers/
│   ├── models/
│   └── requests/
├── vendor/
├── .gitignore
├── Gemfile
├── LICENSE
├── README.md
└── discourse-adplugin.gemspec

目录结构介绍

• app/: 包含插件的主要代码，包括控制器、模型、视图等。
  • assets/: 存放静态资源文件，如CSS、JavaScript等。
  • controllers/: 存放控制器文件，处理用户请求。
  • helpers/: 存放辅助函数文件，提供一些通用的功能。
  • models/: 存放模型文件，处理数据逻辑。
  • views/: 存放视图文件，负责渲染页面。
• config/: 包含插件的配置文件。
  • locales/: 存放国际化文件，支持多语言。
  • settings.yml: 插件的主要配置文件。
• db/: 包含数据库迁移文件。
  • migrate/: 存放数据库迁移脚本，用于创建或修改数据库表结构。
• lib/: 包含插件的核心逻辑和任务。
  • discourse_adplugin/: 插件的核心代码。
  • tasks/: 存放Rake任务文件，用于执行一些自动化任务。
• spec/: 包含测试代码。
  • controllers/: 控制器的测试文件。
  • models/: 模型的测试文件。
  • requests/: 请求的测试文件。
• vendor/: 存放第三方依赖库。
• .gitignore: Git忽略文件，指定哪些文件不需要被版本控制。
• Gemfile: 定义插件的依赖库。
• LICENSE: 插件的许可证文件。
• README.md: 插件的说明文档。
• discourse-adplugin.gemspec: 插件的gemspec文件，定义插件的元数据。

2. 项目的启动文件介绍

Discourse Advertising Plugin 的启动文件主要位于 lib/discourse_adplugin/engine.rb。这个文件定义了插件的引擎，负责加载插件的各个组件。

# lib/discourse_adplugin/engine.rb
module DiscourseAdplugin
  class Engine < ::Rails::Engine
    isolate_namespace DiscourseAdplugin

    config.after_initialize do
      DiscoursePluginRegistry.setup(DiscourseAdplugin)
    end
  end
end

启动文件介绍

• Engine: 定义了插件的引擎，负责加载插件的各个组件。
• isolate_namespace: 隔离命名空间，防止与其他插件或Discourse核心代码冲突。
• config.after_initialize: 在Rails应用初始化后执行的代码块，用于设置插件。

3. 项目的配置文件介绍

Discourse Advertising Plugin 的主要配置文件位于 config/settings.yml。这个文件定义了插件的各种配置选项。

# config/settings.yml
default:
  ad_provider: 'google_adsense'
  ad_client: 'ca-pub-1234567890'
  ad_slot: '0987654321'
  ad_location: 'topic_list_top'
  ad_width: 728
  ad_height: 90

配置文件介绍

• ad_provider: 广告提供商，如Google AdSense、DoubleClick等。
• ad_client: 广告客户端ID。
• ad_slot: 广告单元ID。
• ad_location: 广告显示位置，如topic_list_top、topic_above_post_stream等。
• ad_width: 广告的宽度。
• ad_height: 广告的高度。

通过修改 config/settings.yml 文件，可以自定义广告的显示位置、尺寸、提供商等配置。

---

以上是 Discourse Advertising Plugin 的安装与使用指南，希望对你有所帮助。

discourse-adpluginOfficial Discourse Advertising Plugin. Install & Start Serving Ads on Your Discourse Forum项目地址:https://gitcode.com/gh_mirrors/di/discourse-adplugin