[MOD-2298] Ti.Facebook: Unformatted iOS 10 / 5.5.0 example causes publish-process to break

GitHub Issue	n/a
Type	Bug
Priority	Critical
Status	Closed
Resolution	Fixed
Resolution Date	2016-09-17T11:49:49.000+0000
Affected Version/s	n/a
Fix Version/s	Release 5.5.1, facebook 5.2.7
Components	Facebook
Labels	n/a
Reporter	Chee Kiat Ng
Assignee	Unknown
Created	2016-09-15T21:08:41.000+0000
Updated	2020-01-13T19:58:30.000+0000

Description

During the release for 5.5.0, the docs was not updated for Facebook because the yaml file new entry was not done correctly. This should be fixed so that in the future release, this won't be broken again.

Comments

Chee Kiat Ng 2016-09-15

[~bimmel] can you indicate what you changed on the yaml file here please.

(deactived) Brian Immel 2016-09-15

From the https://github.com/appcelerator-modules/ti.facebook/blob/0ed96e476fce3f55ba53cd1eecee7a906a0868ef/apidoc/Facebook.yml#L17 commit, the "Using Facebook module with iOS 10 and Xcode 8" announcement looked like this:

       **Using Facebook module with iOS 10 and Xcode 8**
       To log in using facebook, we now have to include an entitlements file that enables Keychain Sharing
       Capabilities. To do so, create a /platform/ios/<appname>.entitlements file with this content
       <?xml version="1.0" encoding="UTF-8"?>
       <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
       <plist version="1.0">
       <dict>
       	<key>keychain-access-groups</key>
       	<array>
               <!-- Application ID same as the id value in the tiapp.xml file -->
               <string>APP_ID</string>
       	</array>
       </dict>
       </plist>

and with my changes (https://github.com/appcelerator-modules/ti.facebook/blob/182d35ac63ed01ec713770220bf8ad6c87a6eba3/apidoc/Facebook.yml#L17):

       **Using Facebook module with iOS 10 and Xcode 8**
       To log in using Facebook, we now have to include an entitlements file that enables Keychain Sharing
       Capabilities. To do so, create a /platform/ios/<appname>.entitlements file with this content
               <?xml version="1.0" encoding="UTF-8"?>
               <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
               <plist version="1.0">
               <dict>
               	<key>keychain-access-groups</key>
               	<array>
                       <!-- APP_ID same as the id value in the tiapp.xml file -->
                       <string>$(AppIdentifierPrefix)APP_ID</string>
               	</array>
               </dict>
               </plist>

TL;DR: The code sample needed to be indented to a different level from the content above it. Otherwise, the APIdoc generator will treat all content as text but in this case, since the code sample has HTML tags in it, the generator attempted to pass the tags as part of the page.

Hans Knöchel 2016-09-16

Yes, makes sense. I don't know why it broke the generation, since I would expect that it is "just" unformatted. [~bimmel] Can you do a PR for that and push the apidocs after merging?
(deactived) Brian Immel 2016-09-16

[~hans123], the changes have already been pushed up and the API docs published.
Chee Kiat Ng 2016-09-16

PR here. https://github.com/appcelerator-modules/ti.facebook/pull/68
Eric Merriman 2018-08-06

Cleaning up older fixed issues. If this issue should not have been closed as fixed, please reopen.

JSON Source