# fsys.aar 库模块帮助文档

<details>  <summary>说明</summary>  <p>
aardio 开发环境使用 .aar 文件创建目录索引。
例如文档、范例、工具等目录以及其子目录下基本都有一个  .aar 索引文件。
aardio 本地文档浏览器与在线文档都支持自动转换 .aar 文件为网页格式。

> 为避免误读服务器上被转换为 HTML 的  .aar 文件，fsys.aar.load 在读取 .aar 文件时，如果发现第一个非空白字符是 `<` 则直接返回 null 。

.aar 文件是以`行`为单位的字符串属性表。
每一行的`=`符号之前是显示名称，`=`符号之后是文件或目录路径。
如果路径指定了 .aar 文件则会自动转换为 .aar 所在的目录路径。

.aar 中以 `.` + 英文字母 结尾的文件名被视为文件，反之则被视为目录。
> 如果一个目录名必须以 `.` + 英文字母结尾，则应当在后面添加斜杆或反斜杆显式声明为目录。
> 例如 `Python 3.x=Python 3.x/` 。

可使用 string.table 函数将 .aar 文件内容转换为表对象。
但 string.table 仅有解析功能，返回的表仅包含名值对，而 fsys.aar 可解码、编码 .aar 文件，并且能保留文件排序与获取完整文件路径。
</p></details>

## fsys.aar 成员列表 <a id="fsys.aar" href="#fsys.aar">&#x23;</a>

aardio 开发环境 `.aar` 索引文件解析器。

### fsys.aar.load(path,isFullPath) <a id="fsys.aar.load" href="#fsys.aar.load">&#x23;</a>
加载并解析参数 @path 指定路径的 `.aar` 文件，后缀名必须小写。  
文件不存在或文件内容第一个非空白字符是`<`则返回 null 值。  
解析成功并返回 2 个值：文件数组,目录数组。  
数组都是由显示名称组成的字符串数组。  
数组同时包含显示名称映射到文件名目录的名值对成员。  
参数 @isFullPath 指定是否转换为绝对路径（默认为 true），  
`~`，`//`，`\\` 开头的路径不转换，.aar 路径会转换为目录路径。  
@isFullPath 为 false 则不作任何转换。

### fsys.aar.save(path,files,dirs) <a id="fsys.aar.save" href="#fsys.aar.save">&#x23;</a>
编码并保存 `.aar` 文件，成功返回 true 。  
参数 @path 指定 `.aar` 文件路径。  
files,dirs 分别为文件数组、目录数组。  
files,dirs 的格式必须与 load 方法的返回格式相同。

### fsys.aar.toMarkdown(path) <a id="fsys.aar.toMarkdown" href="#fsys.aar.toMarkdown">&#x23;</a>
使用 load 方法加载并解析  `.aar` 文件，  
并将返回的文件与目录索引转换为 Markdown 格式的链接列表。  
保持原路径值，不会转换为完整路径，不会将 .aar 转换为目录。  
返回字符串值
