添加hook_constants.py注释

jyf_branch
姜雨菲 4 months ago
parent d200df6caf
commit 943b68ee13

@ -1,22 +1,35 @@
# 文章相关事件常量模块
# 该模块定义了与文章操作相关的事件常量、内容钩子常量、位置钩子常量以及资源注入钩子常量
# 这些常量用于在系统中统一标识不同的操作事件和钩子位置,便于模块间的交互和扩展
# 文章操作事件常量
# 用于标识文章详情加载事件,当加载文章详情时触发相关处理逻辑
ARTICLE_DETAIL_LOAD = 'article_detail_load'
# 用于标识文章创建事件,当创建新文章时触发相关处理逻辑
ARTICLE_CREATE = 'article_create'
# 用于标识文章更新事件,当更新已有文章时触发相关处理逻辑
ARTICLE_UPDATE = 'article_update'
# 用于标识文章删除事件,当删除文章时触发相关处理逻辑
ARTICLE_DELETE = 'article_delete'
# 文章内容钩子常量
# 定义文章内容处理的钩子名称,用于在文章内容渲染前后插入自定义处理逻辑
ARTICLE_CONTENT_HOOK_NAME = "the_content"
# 位置钩子常量
# 位置钩子常量字典
# 键为位置标识,值为对应的钩子名称,用于在页面不同位置挂载自定义组件或逻辑
POSITION_HOOKS = {
'article_top': 'article_top_widgets',
'article_bottom': 'article_bottom_widgets',
'sidebar': 'sidebar_widgets',
'header': 'header_widgets',
'footer': 'footer_widgets',
'comment_before': 'comment_before_widgets',
'comment_after': 'comment_after_widgets',
'article_top': 'article_top_widgets', # 文章顶部位置的钩子,用于挂载顶部组件
'article_bottom': 'article_bottom_widgets', # 文章底部位置的钩子,用于挂载底部组件
'sidebar': 'sidebar_widgets', # 侧边栏位置的钩子,用于挂载侧边栏组件
'header': 'header_widgets', # 页头位置的钩子,用于挂载页头组件
'footer': 'footer_widgets', # 页脚位置的钩子,用于挂载页脚组件
'comment_before': 'comment_before_widgets', # 评论区之前位置的钩子,用于在评论前插入内容
'comment_after': 'comment_after_widgets', # 评论区之后位置的钩子,用于在评论后插入内容
}
# 资源注入钩子
# 资源注入钩子常量
# 用于标识在HTML头部注入资源如CSS、JS的钩子可通过该钩子添加头部资源
HEAD_RESOURCES_HOOK = 'head_resources'
# 用于标识在HTML body部分注入资源如JS的钩子可通过该钩子添加body资源
BODY_RESOURCES_HOOK = 'body_resources'

Loading…
Cancel
Save