Updating issues docs to integrate old commit. (#260)

* Updating issues docs to integrate old changelist.

Sohum created some changes to these issues docs last year. I'm
using them as inspiration to update our docs, and to deprecate another
issue.
This commit is contained in:
Simeon 2020-05-19 15:06:49 -07:00 коммит произвёл GitHub
Родитель 3282767d28
Коммит 9cef49f530
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
12 изменённых файлов: 26 добавлений и 17 удалений

Просмотреть файл

@ -6,7 +6,8 @@
A layer in the Lottie file has its render property set to false.
## Remarks
This usually indicates that whoever designed and exported the Lottie file forgot to remove a layer.
This behavior is unexpected. Ensure you're using the latest version of Bodymovin to
export your animation from After Effects.
## Resources

Просмотреть файл

@ -6,7 +6,10 @@
An Adobe Illustrator layer was included in the Lottie file. The layer may not be correctly rendered.
## Remarks
This is usually the result of some part of the animation being authored in Adobe Illustrator. This adds extra data into the Lottie file that Lottie-Windows currently does not understand.
This is usually the result of some part of the animation being authored in
Adobe Illustrator. This adds extra data into the Lottie file that Lottie-Windows
currently does not understand. You can use After Effects to convert the Illustrator
layers to After Effects layers.
## Resources

Просмотреть файл

@ -3,10 +3,12 @@
# Lottie-Windows Warning LP0008
The Lottie file contains layer effects. Layer effects are currently not supported.
The Lottie file contains Layer Effects. Layer Effects are currently not supported
by Lottie-Windows.
## Remarks
Lottie-Windows does not currently support layer effects. It may be possible to work around this by modifying your After Effects project to avoid the use of layer effects.
Lottie does not support Layer Effects on most platforms. It may be possible to
work around this by modifying your After Effects project to avoid the use of Layer Effects.
## Resources

Просмотреть файл

@ -8,7 +8,7 @@ The Lottie file contains expressions, which Lottie-Windows does not currently su
## Remarks
Lottie files may contain JavaScript expressions. Lottie-Windows does not currently support expressions because it renders animations using a declarative rendering system which disallows the imperative modifications allowed by JavaScript.
In many cases the same animation can be achieved without expressions. This will require the designer to adjust their After Effects project to use only declarative animations.
In many cases the same animation can be achieved without expressions. This will require the designer to adjust their After Effects project to use only key frame animations.
## Resources

Просмотреть файл

@ -1,4 +1,5 @@
[comment]: # (name:IgnoredField)
[comment]: # (deprecated)
[comment]: # (name:IgnoredField)
[comment]: # (text:Ignored field: {field}.)
# Lottie-Windows Warning LP0016
@ -6,9 +7,7 @@
A field (aka property) in the Lottie file was ignored. If the field was significant to the appearance of the animation then the animation may look incorrect.
## Remarks
Lottie files use JSON and may contain extra information that is not expected to be in a Lottie file. Lottie-Windows will issue this warning when such information is discovered during parsing.
The presence of this warning is usually just a side effect of some tooling used to author the Lottie file, however it may indicate missing support for a feature in Lottie-Windows. If you suspect that Lottie-Windows should not be ignoring the field please report it as an issue [here](https://github.com/windows-toolkit/Lottie-Windows/issues).
This issue has been deprecated. Please upgrade to a newer version of Lottie-Windows.
## Resources

Просмотреть файл

@ -3,12 +3,12 @@
# Lottie-Windows Warning LT0001
A rectangle has an animated size with a trim path that is not currently supported.
A rectangle shape cannot be rendered if it has a trim path and its size is animated.
## Remarks
The combination of an animated size with certain types of trim path is not yet supported
by Lottie-Windows. You may be able to work around it by adjusting your After Effects
file.
file, for example, consider converting the rectangle to a path instead.
If support for this feature is important for your scenario please provide feedback
by raising it as an issue [here](https://github.com/windows-toolkit/Lottie-Windows/issues).

Просмотреть файл

@ -6,7 +6,8 @@
The Lottie file contains a repeater with a configuration that is not supported by Lottie-Windows.
## Remarks
Lottie-Windows has limited support for repeaters.
Lottie-Windows has limited support for repeaters. Consider creating multiple copies of
layer contents in After Effects instead of using repeaters.
If more complete support for repeaters is important for your scenario please provide feedback
by raising it as an issue [here](https://github.com/windows-toolkit/Lottie-Windows/issues).

Просмотреть файл

@ -6,8 +6,8 @@
The Lottie file contains a text layer. Text layers are not supported by Lottie-Windows.
## Remarks
In order to display text in a Lottie file, convert the text layers to paths when exporting
from After Effects.
In order to display text in a Lottie file, convert the text layers into shape layers by
representing fonts as paths.
## Resources

Просмотреть файл

@ -6,6 +6,8 @@
The Lottie file contains 3D layers. Lottie-Windows does not support 3D layers.
## Remarks
Consider using 2D transforms only. This will ensure cross-platform compatibility and
optimal performance for vector graphics scenarios.
## Resources

Просмотреть файл

@ -138,7 +138,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Lottie.LottieData.Serialization
{
if (pair.unread)
{
_owner._issues.IgnoredField($"{memberName}.{pair.property.Name}");
_owner._issues.UnexpectedField($"{memberName}.{pair.property.Name}");
}
}
}

Просмотреть файл

@ -39,7 +39,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Lottie.LottieData.Serialization
frame = reader.ParseDouble();
break;
default:
_issues.IgnoredField(currentProperty);
_issues.UnexpectedField(currentProperty);
reader.Skip();
break;
}

Просмотреть файл

@ -61,7 +61,8 @@ namespace Microsoft.Toolkit.Uwp.UI.Lottie.LottieData.Serialization
internal void Expressions() => Report("LP0015", "Expressions.");
internal void IgnoredField(string field) => Report("LP0016", $"Ignored field: {field}.");
// LP0016 has been deprecated.
// Was: Ignored field: {field}.
internal void UnexpectedField(string field) => Report("LP0017", $"Unexpected field: {field}.");