[iOS] Add documentation for using alternate app icons on iOS and tvOS. by rolfbjarne · Pull Request #53 · dotnet/docs-mobile

rolfbjarne · 2024-10-29T16:33:55Z

This documentation show the features being implemented in dotnet/macios#21475.

Companion sample projects: dotnet/macios-samples#2.

Internal previews

📄 File	🔗 Preview link
docs/ios/app-fundamentals/images-icons/alternate-app-icons.md	docs/ios/app-fundamentals/images-icons/alternate-app-icons
docs/ios/app-fundamentals/images-icons/index.md	docs/ios/app-fundamentals/images-icons/index

davidbritch · 2024-11-01T13:37:18Z

Always sentence case.

davidbritch · 2024-11-01T13:37:21Z

Always sentence case.

davidbritch

Last lot of changes.

davidbritch · 2024-11-01T13:40:54Z

We're not really meant to do these type of index pages anymore, because they add nothing (basically just duplicating the links in the TOC). IIRC there are only two such pages in the MAUI docs, and they are for links from the IDE.

So I'd delete this.

davidbritch · 2024-11-01T13:43:20Z

The value here should be dotnet-mobile, then an ms.subservice of dotnet-ios.

I'll fix it in the Android docs.

In fact, delete the ms.service line here. It's not needed. The config is coming from docfx.json.

davidbritch · 2024-11-01T13:45:59Z

Image needs resizing - look at the preview at https://review.learn.microsoft.com/en-us/dotnet/ios/app-fundamentals/images-icons/alternate-app-icons?branch=pr-en-us-53

davidbritch · 2024-11-01T13:46:27Z

I'd delete this and put a colon on the end of the previous sentence.

Co-authored-by: David Britch <davidbritch@users.noreply.github.com>

davidbritch · 2024-11-01T14:09:20Z

The TOC needs updating now that the index page has been removed.

davidbritch · 2024-11-01T15:19:18Z

So the issue blocking publication is that the content links to samples that are in a private repo.

They're currently in a private repo, and it may take some time until they're made public. At that point I'll re-add the links.

rolfbjarne · 2024-11-04T10:42:44Z

So the issue blocking publication is that the content links to samples that are in a private repo.

I removed the links to the samples, and I'll add them back (in a different PR) when the samples repo is made public.

davidbritch · 2024-11-04T15:46:46Z

Just took another look at this, and while the page titles use sentence case the headings still need converting to sentence case (e.g. Adding Alternate Icons to a .NET Project should be Adding alternate icons to a .NET project).

This adds support for including all app icons in the app, as well as for specifying alternate app icons. Including all app icons is enabled by setting the following MSBuild property: ```xml <PropertyGroup> <IncludeAllAppIcons>true</IncludeAllAppIcons> </PropertyGroup> ```` This will make the `ACTool` task pass `--include-all-app-icons` to `actool` when compiling the asset catalog. Specifying alternate app icon(s) is enabled by setting the following MSBuild item: ```xml <ItemGroup> <AlternateAppIcon Include="MyAlternateAppIcon" /> <AlternateAppIcon Include="MyOtherAlternateAppIcon" /> </ItemGroup> ``` Note that the included value is the name if the icon in question, not the path or the filename of the actual icon file (this way there's no need to have different items for different platforms, because there are some platform differences with regards to paths and icon file extensions). In order to make the behavior consistent, this PR also adds support for specifying the app icon itself using an MSBuild property (in addition to the existing Info.plist property `XSAppIconAssets`, which will eventually be deprecated): ```xml <PropertyGroup> <AppIcon>MyAppIcon</AppIcon> </PropertyGroup> ``` The same note applies here: the value is the name of the icon. Note about platforms: the code is there for all platforms (iOS, tvOS, macOS and Mac Catalyst), but alternate app icons only seem to work for iOS and tvOS. `UIApplication.SupportsAlternateIcons` always returns `false` on Mac Catalyst (googling only find people in the same situation), and macOS doesn't have this API to begin with (nor anything similar): Also: * Add a bunch of tests. * Document on our website: dotnet/docs-mobile#53 * Samples for iOS and tvOS: dotnet/macios-samples#2 Fixes #12790. Fixes #20182.

rolfbjarne · 2024-11-05T10:40:02Z

Just took another look at this, and while the page titles use sentence case the headings still need converting to sentence case (e.g. Adding Alternate Icons to a .NET Project should be Adding alternate icons to a .NET project).

I think I fixed them all now.

I think we should wait with merging this until the new feature has actually been released though (should be the next service release after .NET 9).

This reverts commit 0645b3d. These links are now public.

rolfbjarne · 2024-12-04T08:58:49Z

Just took another look at this, and while the page titles use sentence case the headings still need converting to sentence case (e.g. Adding Alternate Icons to a .NET Project should be Adding alternate icons to a .NET project).

I think I fixed them all now.

I think we should wait with merging this until the new feature has actually been released though (should be the next service release after .NET 9).

The feature has been released so this is good to go now.

The samples repository is also public now, so I re-added the links to the samples.

davidbritch

LGTM!

rolfbjarne added 2 commits October 29, 2024 11:09

Port Xamarin documentation about alternate app icons to .NET.

344a6ca

port

64595d0

rolfbjarne mentioned this pull request Oct 29, 2024

[msbuild] Add support for alternate app icons. dotnet/macios#21475

Merged

davidbritch suggested changes Oct 31, 2024

View reviewed changes

rolfbjarne added 2 commits October 31, 2024 18:55

Fix according to review.

18701c3

fix warnings

7322b1b

davidbritch reviewed Oct 31, 2024

View reviewed changes

Comment thread docs/ios/app-fundamentals/images-icons/alternate-app-icons.md Outdated

rolfbjarne added 6 commits November 1, 2024 08:27

Try out xrefs

823d1c5

create parent landing pages

ca1a5e2

More links

84c9fee

Fix yaml

85a07fa

Fix yml format

c78b38d

Fix typo

4b53e07

rolfbjarne marked this pull request as ready for review November 1, 2024 08:31

davidbritch reviewed Nov 1, 2024

View reviewed changes

Comment thread docs/ios/TOC.yml Outdated

Copy link
Copy Markdown

davidbritch Nov 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Always sentence case.

davidbritch reviewed Nov 1, 2024

View reviewed changes

Comment thread docs/ios/TOC.yml Outdated

Copy link
Copy Markdown

davidbritch Nov 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Always sentence case.

davidbritch suggested changes Nov 1, 2024

View reviewed changes

rolfbjarne and others added 2 commits November 1, 2024 14:54

Apply suggestions from code review

f17d02d

Co-authored-by: David Britch <davidbritch@users.noreply.github.com>

Apply feedback.

5f298d5

davidbritch reviewed Nov 1, 2024

View reviewed changes

Comment thread docs/ios/TOC.yml Outdated

Copy link
Copy Markdown

davidbritch Nov 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The TOC needs updating now that the index page has been removed.

Fix warning.

9ee1d98

dalexsoto approved these changes Nov 1, 2024

View reviewed changes

Remove links to samples.

0645b3d

They're currently in a private repo, and it may take some time until they're made public. At that point I'll re-add the links.

rolfbjarne added 2 commits November 5, 2024 11:34

Sentence case

31977bc

One more

c3d3141

davidbritch added the do-not-merge Do not merge label Nov 5, 2024

rolfbjarne added 3 commits December 4, 2024 09:45

Revert "Remove links to samples."

0caf323

This reverts commit 0645b3d. These links are now public.

Link to location in repository

f251fe9

Merge remote-tracking branch 'origin/main' into alternate-app-icons

602472a

davidbritch approved these changes Dec 4, 2024

View reviewed changes

davidbritch removed the do-not-merge Do not merge label Dec 4, 2024

davidbritch merged commit 9428e50 into dotnet:main Dec 4, 2024

davidbritch deleted the alternate-app-icons branch December 4, 2024 09:58

Conversation

rolfbjarne commented Oct 29, 2024 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Internal previews

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

davidbritch left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

davidbritch commented Nov 1, 2024

Uh oh!

rolfbjarne commented Nov 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davidbritch commented Nov 4, 2024

Uh oh!

rolfbjarne commented Nov 5, 2024

Uh oh!

rolfbjarne commented Dec 4, 2024

Uh oh!

davidbritch left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rolfbjarne commented Oct 29, 2024 •

edited by github-actions Bot

Loading

rolfbjarne commented Nov 4, 2024 •

edited

Loading