Cooklang-chef 项目中的特殊元数据键详解

Cooklang-chef 项目中的特殊元数据键详解

cooklang-chef A CLI to manage cooklang recipes 项目地址: https://gitcode.com/gh_mirrors/co/cooklang-chef

什么是元数据键

在 Cooklang-chef 项目中，元数据键是用于描述食谱(recipe)额外信息的特殊标记。它们以键值对的形式出现在食谱文件中，为食谱提供丰富的上下文信息。这些元数据不仅能让食谱更易于理解，还能帮助工具更好地处理和展示食谱内容。

核心元数据键及其用途

1. 名称覆盖 (name)

• 作用：默认情况下，食谱名称取自文件名，但使用name键可以自定义显示名称
• 示例：name: 外婆的红烧肉
• 使用场景：当文件名不足以表达食谱特色时特别有用

2. 标签系统 (tags)

• 作用：为食谱添加分类标签，便于检索和归类
• 格式：多个标签用英文逗号分隔
• 示例：tags: 中式,家常菜,下饭菜
• 最佳实践：建议建立一致的标签体系，如按菜系、烹饪方式、适用场景等分类

3. 表情符号 (emoji)

• 作用：为食谱添加视觉标识，增加辨识度
• 格式：支持直接使用emoji或短代码形式
• 示例：
  • 直接使用：emoji: 🍜
  • 短代码：emoji: :ramen:
• 设计建议：选择与食谱内容高度相关的emoji

4. 食谱描述 (description)

• 作用：提供食谱的简要说明
• 示例：description: 这道菜源自四川传统做法，麻辣鲜香，特别适合冬季食用
• 写作技巧：建议包含特色、起源、适用场合等关键信息

来源与作者信息

1. 作者信息 (author)

• 作用：记录食谱创作者信息
• 格式：
  • 简单格式：author: 张三
  • 带链接：author: 张三 <zhangsan.example.com>
  • 仅链接：author: example.com/zhangsan
• 注意事项：链接需使用可访问的URL格式

2. 来源信息 (source)

• 作用：标明食谱原始出处
• 格式：与author相同
• 示例：source: 家传秘方 <family-recipes.example.com>
• 版权提示：使用他人食谱时务必注明来源

时间管理元数据

Cooklang-chef 提供了灵活的时间记录方式，满足不同场景需求：

1. 总时间 (time)

• 作用：记录食谱制作总耗时
• 特点：如果定义在prep_time和cook_time之后，会覆盖这两个值
• 示例：time: 2小时30分钟

2. 准备时间 (prep_time)

• 作用：专门记录准备食材的时间
• 覆盖规则：如果定义在time之后，会覆盖time中的准备时间部分
• 示例：prep_time: 45分钟

3. 烹饪时间 (cook_time)

• 作用：记录实际烹饪耗时
• 覆盖规则：如果定义在time之后，会覆盖time中的烹饪时间部分
• 示例：cook_time: 1小时15分钟

时间元数据使用建议

1. 简单场景：只需总时间时，仅使用time即可
2. 详细记录：需要区分准备和烹饪时间时，使用prep_time和cook_time
3. 注意顺序：后定义的键会覆盖先定义的冲突值
4. 格式统一：建议采用"X小时Y分钟"或纯分钟数的统一格式

实际应用示例

name: 秘制牛肉面
tags: 面食,家常,快捷
emoji: :ramen:
description: 15分钟快速牛肉面，汤头浓郁，肉质鲜嫩
author: 李厨师长 <licook.example.com>
source: 家庭厨房杂志2023年3月刊
prep_time: 10分钟
cook_time: 5分钟

通过合理使用这些特殊元数据键，你的食谱将更加规范、易读且功能丰富。Cooklang-chef 能够利用这些元数据提供更好的搜索、分类和展示体验。

cooklang-chef A CLI to manage cooklang recipes 项目地址: https://gitcode.com/gh_mirrors/co/cooklang-chef