示例

 This is a <strong>valid</strong> string with some <color value="red">red <b>bold text</b></color>.
 This is a <strong>valid</>string with some <color value="red">red <b>bold text</></>.
 This is a <strong>valid</Hakuna> string with some <color value="red">red <b>bold text</mata></ta>. // Will work but generates an error
 This is a <strong>valid</> string with some <color value="red">red <b>bold text<//>.

解析器

构造函数

GONMarkupParser 类提供两个类构造函数。

• + defaultMarkupParser 是一个注册了所有默认标签的解析器（更多信息请见默认标签摘要）
• + emptyMarkgiupParser 是一个没有注册任何标签的解析器

属性

解析器可以有一个预处理和后处理块，将在解析前后被调用。这允许您在解析前执行一些字符串替换操作，例如。

解析器有两个有趣的属性

• replaceNewLineCharactersFromInputString，用于从输入字符串中删除所有换行符字符。使用 br 标记来添加新行。默认为 NO。
• replaceHTMLCharactersFromOutputString，在解析后替换字符串中的所有 HTML 实体。默认为 YES。

defaultConfiguration 将包含生成字符串的默认样式配置。内容应该是有效的属性参数，您可以将其传递给 - addAttributes:range: 的 NSMutableAttributedString 对象。例如，要设置默认文字颜色，可以设置 NSForegroundColorAttributeName。

为了调试目的，您可以配置 debugLevel 属性。

assertOnError 属性也用于在遇到错误时生成断言。

配置

解析器必须注册一些标记才能正确处理字符串。
使用 - addMarkup:、- addMarkups:、- removeMarkups: 和 - removeAllMarkups 方法来实现此目的。
每次只能对一个解析器添加一个标记。

已注册字体

为了简化字体使用，可以使用 - registerFont:forKey: 方法注册字体，然后通过给定的键引用它们。
与 <font> 标记一起非常实用，允许您直接使用代码而不是完整的字体名称。您还可以使用 mainFont、titleFont 等代码来轻松地在所有字符串中更新它们。

GONMarkupParserManager

共享解析器

共享解析器可以供使用，因此您无需创建一个并在整个应用程序中引用它。
共享解析器默认配置了所有标记。

解析器注册

可以将一些解析器注册到此类，这样您就可以在应用程序的各个位置使用它们。

可用的UIKit类别

UILabel/UITextField/UITextView
为 UILabel、UITextField 和 UITextView 添加了 2 个方法，允许您使用标记的字符串轻松更新其属性字符串。

• - setMarkedUpText:(NSString *)text parser:(GONMarkupParser *)parser 将使用给定的解析器来处理字符串并生成属性字符串。
• - setMarkedUpText:(NSString *)text 将使用共享的解析器，即 [GONMarkupParserManager sharedParser]。

如果没有为 NSForegroundColorAttributeName、NSFontAttributeName 和 NSParagraphStyleAttributeName 设置解析器默认配置，则将使用默认的组件属性 textColor、textAlignment 和 font。

如果您想将组件样式用作默认解析器配置，强烈建议您使用这些方法。

锚支持

通过使用 <a href="..."> 标记实现锚支持。
如果 NSAttributedString 在 UITextView 中显示，您可以处理对其的用户的点击。
确保您的 UITextView 是 不可编辑的、可选择的 并设置了其 代理。
然后，在您的代理中实现
- (BOOL)textView:(UITextView *)textView shouldInteractWithURL:(NSURL *)URL inRange:(NSRange)characterRange
方法。

链接不会应用颜色样式。您必须使用 UITextView 的 linkTextAttributes 属性来设置它。

默认标签

摘要

重置

重置是一个特殊标签，允许您保护字符串的一部分。您还可以通过设置< strong>all属性强制标记忽略默认解析配置。

如何添加新的标记

您可以在应用程序中添加新的标记，以添加新样式，或仅为了给文本添加语义，允许您在不更改输入字符串的情况下更新渲染。
共有3种方法可以实现。

添加新的简单标记

在应用程序中添加新的标记的最简单方法之一是使用以下3个类之一

• GONMarkupNamedColor，允许您添加能够更新文本颜色的标记
• GONMarkupNamedFont，允许您添加能够更新文本字体的标记
• GONMarkupSimple 允许您添加标记，以更新所有文本属性。字典旨在与您可能传给使用 -setAttributes:range: 方法配置 NSMutableAttributedString 的字典相同。

示例

    // Retrieve shared parser
    GONMarkupParser *parser = [GONMarkupParserManager sharedParser];
    
    // Add a named color markup
    [parser addMarkup:[GONMarkupNamedColor namedColorMarkup:[UIColor redColor]
               forTag:@"red"]];

    // Add a named font markup
    [parser addMarkup:[GONMarkupNamedFont namedFontMarkup:[UIFont systemFontOfSize:12.0] 
               forTag:@"small"]];

    // Add a custom markup, that will center text when used, and display it in pink.
    NSMutableParagraphStyle *defaultParagraphStyle = [[NSParagraphStyle defaultParagraphStyle] mutableCopy];
    defaultParagraphStyle.alignment = NSTextAlignmentCenter;
    [parser addMarkup:[GONMarkupSimple simpleMarkup:@"pwet"
                                              style:@{
                                                        NSParagraphStyleAttributeName : defaultParagraphStyle,
                                                        NSForegroundColorAttributeName : [@"pink" representedColor] // NSString+Color
                                                     }
                                    mergingStrategy:GONMarkupSimpleMergingStrategyMergeAll]];

添加基于块的新的标记

对于更复杂的标记，您可以添加 GONMarkupBlock 实例。

它有5个参数

• openingMarkupBlock，在找到标记打开时调用。用于将自定义配置推入堆栈
• closingMarkupBlock，标记关闭后调用一次。
• updatedContentStringBlock，在 closingMarkupBlock 之后立即调用，允许您覆盖返回的字符串
• prefixStringForContextBlock，在 openingMarkupBlock 之后立即调用，允许您返回前缀
• suffixStringForContextBlock，在 openingMarkupBlock 之后立即调用，允许您返回后缀

示例

    // Retrieve shared parser
    GONMarkupParser *parser = [GONMarkupParserManager sharedParser];
    
    // Custom markup, based on block
    GONMarkupBlock *markupBlock = [GONMarkupBlock blockMarkup:@"custom"];
    markupBlock.openingMarkupBlock = ^(NSMutableDictionary *configurationDictionary, NSString *tag, NSMutableDictionary *context, NSDictionary *attributes) {
        // Update font size
        [configurationDictionary setObject:[UIFont boldSystemFontOfSize:69.0]
                                    forKey:NSFontAttributeName];
        
        // Update text color
        [configurationDictionary setObject:[@"brown" representedColor]
                                    forKey:NSForegroundColorAttributeName];
    };

    [parser addMarkup:markupBlock];

创建一个新的 GONMarkup 子类

您可以通过继承 GONMarkup 类添加自定义标记。

通过继承添加新标记对于您想要在多个项目中重用标记或实现更复杂的行为非常有用。在进行继承时，您可以访问共享对象，允许您保留数据并在各个标记处理程序之间共享数据。

例如，查看当前定义的标记。 ;). 请参见 GONMarkupList 和 GONMarkupListItem，它们使用共享上下文进行实现。

故障排除

某些文本丢失

检查您的标记是否正确注册，您的标签是否正确匹配。

在使用 < / > 时，某些文本丢失

在文本中使用 &lt; 和 &gt;。

我的标签关闭后文本颜色仍然生效。

这是由 NSAttributedString 的内部行为引起的。一旦设置了颜色，它就会应用，直到设置新的颜色。
为了避免这个问题，请确保在您的解析器中设置了默认文本颜色（defaultConfiguration / NSForegroundColorAttributeName 键）。您可以在 UILabel / UITextField 上使用 setMarkedUpText: 来使用默认组件配置。

文本样式未应用于我的链接

有关更多信息，请参阅 锚点支持。

当使用自定义字体时，遇到一些崩溃

请确保使用正确的字体名称，或者您正在使用的字体代码已正确注册到您的解析器。
想倾出您的设备上所有可用的字体并检查它们的真实名称吗？
请看这里的 DUMP_FONT_LIST()

使用 <br> 不会插入新行

<br> 单独在 GONMarkupParser 中是无效的。请确保使用 <br/>。

颜色未应用

检查您颜色的语法是否正确。
有关支持的语法，请参阅 NSString+UIColor 的更多信息，这用于从您的字符串值计算颜色。

金·卡戴珊打破互联网了吗？

没有，绝对没有。我昨天还能推送到GitHub。

演变

• 允许自定义列表的缩进前缀。
• 在解析器和标记器中实现 NSCoder。
• 允许在解析器/标记器上使用 copy。
• 改进关闭标签。

贡献者

请参阅 GitHub 上的 贡献者页面。

变更日志

更改日志可以在这里找到