首页
/ PScribo 项目使用教程

PScribo 项目使用教程

2024-08-16 13:11:34作者:幸俭卉

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

PScribo 项目的目录结构如下:

PScribo/
├── Src/
│   ├── Private/
│   │   ├── Resolve-ImageUri.ps1
│   │   ├── Resolve-PScriboStyleColor.ps1
│   │   ├── Resolve-PScriboToken.ps1
│   │   ├── Set-PScriboSectionBreakEnd.ps1
│   │   ├── Test-CharsInPath.ps1
│   │   ├── Test-PScriboStyle.ps1
│   │   ├── Test-PScriboStyleColor.ps1
│   │   └── Write-PScriboProcessSectionId.ps1
│   └── Public/
│       ├── BlankLine.ps1
│       ├── Document.ps1
│       ├── DocumentOption.ps1
│       ├── Export-Document.ps1
│       ├── Footer.ps1
│       ├── Header.ps1
│       ├── Image.ps1
│       ├── LineBreak.ps1
│       ├── PageBreak.ps1
│       ├── Paragraph.ps1
│       ├── Section.ps1
│       ├── Set-Style.ps1
│       ├── Style.ps1
│       ├── Table.ps1
│       ├── TableStyle.ps1
│       ├── Text.ps1
│       ├── TOC.ps1
│       └── Write-PScriboMessage.ps1
└── README.md

目录结构介绍

  • Src/Private/: 包含项目的私有函数脚本文件。
  • Src/Public/: 包含项目的公共函数脚本文件,这些函数可以被用户直接调用。
  • README.md: 项目的主文档文件,包含项目的基本介绍和使用说明。

2. 项目的启动文件介绍

PScribo 项目的启动文件是 Document.ps1,位于 Src/Public/ 目录下。该文件是创建文档的主要入口点,用户可以通过调用该文件中的函数来开始创建文档。

启动文件介绍

  • Document.ps1: 该文件包含 Document 函数,用于初始化一个新的文档对象。用户可以通过调用该函数来开始创建文档,并设置文档的基本属性。

3. 项目的配置文件介绍

PScribo 项目没有明确的配置文件,但用户可以通过调用 DocumentOption.ps1 文件中的函数来设置文档的选项和样式。

配置文件介绍

  • DocumentOption.ps1: 该文件包含 DocumentOption 函数,用于设置文档的各种选项,如页面大小、页边距、字体样式等。用户可以通过调用该函数来定制文档的外观和格式。

以上是 PScribo 项目的基本使用教程,希望对您有所帮助。

登录后查看全文