# Documentation **URL:** https://forums.synfig.org/c/development/documentation/30.md [Latest](https://forums.synfig.org/latest.md) · [Categories](https://forums.synfig.org/categories.md) · [Tags](https://forums.synfig.org/tags.md) --- ## [About the Documentation category](https://forums.synfig.org/t/about-the-documentation-category/37)
**Author:** [@system](https://forums.synfig.org/u/system)\ **Replies:** 0\ **Last updated:** [April 14, 2010, 11:05am UTC](https://forums.synfig.org/t/about-the-documentation-category/37 "2010-04-14T11:05:06Z")
Discuss here anything about documentation of Synfig (wiki, offline help, Synfig studio help system, etc.) --- ## [Proposed: Commenting Standard](https://forums.synfig.org/t/proposed-commenting-standard/3195)
**Author:** [@CodeMouse92](https://forums.synfig.org/u/CodeMouse92)\ **Replies:** 2\ **Last updated:** [June 7, 2016, 6:44pm UTC](https://forums.synfig.org/t/proposed-commenting-standard/3195 "2016-06-07T18:44:08Z")
I brought this up on the mailing list, but based on the initial response, I wanted to repost it here for reach and lifespan, as stuff on mailing lists tends to get buried. (You can read the thread at sourceforge.net/p/sy… --- ## [Welcome to Documentation forum](https://forums.synfig.org/t/welcome-to-documentation-forum/847)
**Author:** [@Genete](https://forums.synfig.org/u/Genete)\ **Replies:** 0\ **Last updated:** [April 14, 2010, 11:05am UTC](https://forums.synfig.org/t/welcome-to-documentation-forum/847 "2010-04-14T11:05:06Z")
Welcome to Documentation forum. You’re welcome to discuss here anything about the wiki organization, the offline help and the built in help for Synfig CLI, and Synfig Studio. Issues regarding documentation in code are … --- ## [New Python library to modify Synfig files: sangfroid 0.1](https://forums.synfig.org/t/new-python-library-to-modify-synfig-files-sangfroid-0-1/15186)
**Author:** [@Marnanel](https://forums.synfig.org/u/Marnanel)\ **Replies:** 2\ **Last updated:** [October 8, 2025, 10:54pm UTC](https://forums.synfig.org/t/new-python-library-to-modify-synfig-files-sangfroid-0-1/15186 "2025-10-08T22:54:29Z")
I have so many bits and pieces of Python code to modify Synfig files that I put them together into a library. This is the first release: sangfroid version 0.1 liverpool. The easiest way to install it is pip install sang… --- ## [Transferring documentation from old wiki](https://forums.synfig.org/t/transferring-documentation-from-old-wiki/16657)
**Author:** [@Svarov](https://forums.synfig.org/u/Svarov)\ **Replies:** 7\ **Last updated:** [July 29, 2025, 4:28am UTC](https://forums.synfig.org/t/transferring-documentation-from-old-wiki/16657 "2025-07-29T04:28:55Z")
Hey forum people, I started transferring documentation from old wiki to readthedocs. First candidate for transferring is Convert page: Convert - Synfig Animation Studio First, I gotta complain about the choice of docum… --- ## [Converter development requirements](https://forums.synfig.org/t/converter-development-requirements/16608)
**Author:** [@zainal](https://forums.synfig.org/u/zainal)\ **Replies:** 3\ **Last updated:** [June 28, 2025, 8:00pm UTC](https://forums.synfig.org/t/converter-development-requirements/16608 "2025-06-28T20:00:41Z")
Are there any requirements I need to follow if I want to create a converter and submit a pull request? --- ## [Python library to read .sif/.sifz](https://forums.synfig.org/t/python-library-to-read-sif-sifz/14302)
**Author:** [@Marnanel](https://forums.synfig.org/u/Marnanel)\ **Replies:** 7\ **Last updated:** [June 30, 2024, 9:43pm UTC](https://forums.synfig.org/t/python-library-to-read-sif-sifz/14302 "2024-06-30T21:43:43Z")
I often have reason to modify .sif files from a Python script. I have an ad hoc library I have built for this, on top of the XML parser Beautiful Soup. I was wondering whether there was an existing library I could use i… --- ## [Specification for SFG and SIF?](https://forums.synfig.org/t/specification-for-sfg-and-sif/3426)
**Author:** [@faraway](https://forums.synfig.org/u/faraway)\ **Replies:** 7\ **Last updated:** [December 7, 2023, 7:15pm UTC](https://forums.synfig.org/t/specification-for-sfg-and-sif/3426 "2023-12-07T19:15:05Z")
Are there plans to freeze the \*.sfg and \*.sif format for v1.0? Also, is there a spec? I am interested in making a Python module for loading and saving it. --- ## [What is connecting synfig-core modules to synfig-studio UI?](https://forums.synfig.org/t/what-is-connecting-synfig-core-modules-to-synfig-studio-ui/14137)
**Author:** [@GregorysonofCarl](https://forums.synfig.org/u/GregorysonofCarl)\ **Replies:** 3\ **Last updated:** [June 14, 2023, 2:52am UTC](https://forums.synfig.org/t/what-is-connecting-synfig-core-modules-to-synfig-studio-ui/14137 "2023-06-14T02:52:53Z")
Hello again, I’ve been studying the Synfig source code lately just to try and understand its structure a little better. Specifically I’ve been trying to understand exactly how the UI elements of the gui application know… --- ## [Documentation contribution](https://forums.synfig.org/t/documentation-contribution/12186)
**Author:** [@veermetri05](https://forums.synfig.org/u/veermetri05)\ **Replies:** 14\ **Last updated:** [September 9, 2022, 12:50pm UTC](https://forums.synfig.org/t/documentation-contribution/12186 "2022-09-09T12:50:22Z")
Hello, I was thinking of writing documentation(user) and did the setup required for it (Sphinx tools). Can anyone please suggest what should I start documenting first, I have seen some TODO in some pages, should I compl… --- ## [Templates ready-made](https://forums.synfig.org/t/templates-ready-made/12335)
**Author:** [@iqbal2abish](https://forums.synfig.org/u/iqbal2abish)\ **Replies:** 2\ **Last updated:** [June 29, 2021, 12:04am UTC](https://forums.synfig.org/t/templates-ready-made/12335 "2021-06-29T00:04:47Z")
how may I get ready-made templates for synfig source file for editing and changing ? --- ## [Will Synfig ever open .piv?](https://forums.synfig.org/t/will-synfig-ever-open-piv/12192)
**Author:** [@Manoanimations](https://forums.synfig.org/u/Manoanimations)\ **Replies:** 1\ **Last updated:** [May 26, 2021, 7:22am UTC](https://forums.synfig.org/t/will-synfig-ever-open-piv/12192 "2021-05-26T07:22:04Z")
It opens .stk, but will it ever be supported to open .piv? What are the projects. Most of the characters that I use on the internet are inside a .piv and are “embedded pieces”. They use the Pivot join function. Since the… --- ## [New documentation](https://forums.synfig.org/t/new-documentation/10931)
**Author:** [@KonstantinDmitriev](https://forums.synfig.org/u/KonstantinDmitriev)\ **Replies:** 16\ **Last updated:** [May 21, 2021, 3:50am UTC](https://forums.synfig.org/t/new-documentation/10931 "2021-05-21T03:50:53Z")
Hi everyone! For many years we’ve been using MediaWiki for Synfig documentation. And there were a lot of problems with that: MediaWiki is hard to maintain (update version), it is affected by spambots and it is missing… --- ## [The mathematics behind interpolations](https://forums.synfig.org/t/the-mathematics-behind-interpolations/11977)
**Author:** [@Bobo\_the\_King](https://forums.synfig.org/u/Bobo_the_King)\ **Replies:** 2\ **Last updated:** [March 27, 2021, 8:22am UTC](https://forums.synfig.org/t/the-mathematics-behind-interpolations/11977 "2021-03-27T08:22:31Z")
I’d add this to the wiki myself, but everything seems to be locked. I want to include information on each of the interpolations, with special focus on the relevant differential equations. Here’s what I have so far: Le… --- ## [Can’t find "\_debug" folder](https://forums.synfig.org/t/can-t-find-debug-folder/10699)
**Author:** [@arya](https://forums.synfig.org/u/arya)\ **Replies:** 1\ **Last updated:** [March 6, 2020, 4:15am UTC](https://forums.synfig.org/t/can-t-find-debug-folder/10699 "2020-03-06T04:15:41Z")
I can’t find \_debug file while setting up make setting in synergy project. I have autobuild folder but I was expecting \_debug folder as mentioned in setting up configure section (last section) --- ## [Synfig .sif File Format Specification?](https://forums.synfig.org/t/synfig-sif-file-format-specification/2600)
**Author:** [@DashW](https://forums.synfig.org/u/DashW)\ **Replies:** 4\ **Last updated:** [July 12, 2019, 1:28pm UTC](https://forums.synfig.org/t/synfig-sif-file-format-specification/2600 "2019-07-12T13:28:43Z")
Hi guys, Is there any formal specification for the .sif (uncompressed .sifz) file format, or even something like an XML Schema Definition, so that I can potentially make plugins to read and write it from other applicati… --- ## [Google Season of Docs 2019](https://forums.synfig.org/t/google-season-of-docs-2019/9692)
**Author:** [@Reshabh](https://forums.synfig.org/u/Reshabh)\ **Replies:** 3\ **Last updated:** [April 17, 2019, 10:47am UTC](https://forums.synfig.org/t/google-season-of-docs-2019/9692 "2019-04-17T10:47:44Z")
Hello everyone! Google Season of Docs is similar to GSoC but it revolves around docs and technical write-ups. More information can be found on their official site https://developers.google.com/season-of-docs Since it j… --- ## [Synfig code documentation](https://forums.synfig.org/t/synfig-code-documentation/9494)
**Author:** [@KonstantinDmitriev](https://forums.synfig.org/u/KonstantinDmitriev)\ **Replies:** 0\ **Last updated:** [February 28, 2019, 6:25pm UTC](https://forums.synfig.org/t/synfig-code-documentation/9494 "2019-02-28T18:25:18Z")
Hello everyone! I have started documenting code structure of Synfig. By this moment I’ve got done describing “synfig-core”. Please read it here - https://synfig-docs-dev.readthedocs.io/en/latest/common/structure.html --- ## [Update Features Page in main website](https://forums.synfig.org/t/update-features-page-in-main-website/3093)
**Author:** [@jcome](https://forums.synfig.org/u/jcome)\ **Replies:** 3\ **Last updated:** [September 19, 2014, 2:17pm UTC](https://forums.synfig.org/t/update-features-page-in-main-website/3093 "2014-09-19T14:17:24Z")
Shall we update the features page at our website: synfig.org/cms/en/features/ , since there are some significant new features introduced recently. For examples: bone system dynamic convert (it may be worth to mention t… --- ## [\[Tutorial-Coding\] Adding a Render Progress Bar](https://forums.synfig.org/t/tutorial-coding-adding-a-render-progress-bar/9260)
**Author:** [@BobSynfig](https://forums.synfig.org/u/BobSynfig)\ **Replies:** 0\ **Last updated:** [January 4, 2019, 4:24pm UTC](https://forums.synfig.org/t/tutorial-coding-adding-a-render-progress-bar/9260 "2019-01-04T16:24:14Z")
For the devs, I added some reference in the Wiki. https://wiki.synfig.org/Dev:Adding\_a\_Render\_progress\_bar Cheers :slight\_smile: --- ## [\[Tutorial-Coding\] Play a notification sound in Synfig / Add a toggle in preferences](https://forums.synfig.org/t/tutorial-coding-play-a-notification-sound-in-synfig-add-a-toggle-in-preferences/9211)
**Author:** [@BobSynfig](https://forums.synfig.org/u/BobSynfig)\ **Replies:** 0\ **Last updated:** [December 16, 2018, 8:35pm UTC](https://forums.synfig.org/t/tutorial-coding-play-a-notification-sound-in-synfig-add-a-toggle-in-preferences/9211 "2018-12-16T20:35:32Z")
For the devs, after adding Render Done sound to the code, I added some reference in the Wiki. It can be used as well to implement a toggle in the Preferences. https://wiki.synfig.org/Dev:Adding\_a\_Sound\_notification Ch… --- ## [Reference haramanai sifplayer in Scripts & Tools ?](https://forums.synfig.org/t/reference-haramanai-sifplayer-in-scripts-tools/2579)
**Author:** [@d.j.a.y](https://forums.synfig.org/u/d.j.a.y)\ **Replies:** 3\ **Last updated:** [September 26, 2018, 4:12pm UTC](https://forums.synfig.org/t/reference-haramanai-sifplayer-in-scripts-tools/2579 "2018-09-26T16:12:39Z")
Hello, What do you think to reference this great tools there ? synfig.org/cms/en/download/tools/ Could this give more visibilty to that great initiative… see(:ya! Nota : sifplayer / html5 canvas player, thread : HT… --- ## [Work Items Restructuring Project](https://forums.synfig.org/t/work-items-restructuring-project/849)
**Author:** [@oho](https://forums.synfig.org/u/oho)\ **Replies:** 88\ **Last updated:** [August 26, 2018, 10:29am UTC](https://forums.synfig.org/t/work-items-restructuring-project/849 "2018-08-26T10:29:20Z")
Work Item Documentation: ongoing explain current structure / existing restructuring plans setting targets for docs describing content for docs develop proposal for structure / content / target via Forum (this post … --- ## [Kid's doc ...](https://forums.synfig.org/t/kids-doc/873)
**Author:** [@oho](https://forums.synfig.org/u/oho)\ **Replies:** 9\ **Last updated:** [August 1, 2017, 10:32am UTC](https://forums.synfig.org/t/kids-doc/873 "2017-08-01T10:32:11Z")
Just an idea… after all the work is done for 0.62.01, and the offline beginners’ doc, I might start creating a Kids’ doc. I plan to do a workshop with Synfig in the local grammar school (6yr - 10yr old boys & girls). … --- ## [Doubt about the term "Insert Item (Smart)" term in the docs](https://forums.synfig.org/t/doubt-about-the-term-insert-item-smart-term-in-the-docs/4141)
**Author:** [@samix](https://forums.synfig.org/u/samix)\ **Replies:** 1\ **Last updated:** [February 14, 2017, 9:14am UTC](https://forums.synfig.org/t/doubt-about-the-term-insert-item-smart-term-in-the-docs/4141 "2017-02-14T09:14:23Z")
Okay, I’ve seen the term “Insert Item (Smart)” in various places, the one I can remember is the how-to I was going over at: wiki.synfig.org/Doc:Flower\_Animation. However, I can’t find the option on my menu (not on the n… --- ## [PDF tutorials and documentation](https://forums.synfig.org/t/pdf-tutorials-and-documentation/3936)
**Author:** [@JokingReaper](https://forums.synfig.org/u/JokingReaper)\ **Replies:** 1\ **Last updated:** [July 11, 2016, 2:10pm UTC](https://forums.synfig.org/t/pdf-tutorials-and-documentation/3936 "2016-07-11T14:10:09Z")
Hello Synfig Community. This is the second time i write this post, because the first time the moderators must have deleted it (I’m a new user, so probably they thought it was spam :unamused: ). But whatever, they are j… --- ## [Productivity](https://forums.synfig.org/t/productivity/3588)
**Author:** [@kwilco](https://forums.synfig.org/u/kwilco)\ **Replies:** 7\ **Last updated:** [November 17, 2015, 2:45pm UTC](https://forums.synfig.org/t/productivity/3588 "2015-11-17T14:45:16Z")
It seems that most Synfig users are happy to dabble in animation. However, Synfig could also be a productivity booster for those of who have a different purpose. I create educational videos and tutorials. This means usin… --- ## [Wiki update to 1.0 ... help needed !](https://forums.synfig.org/t/wiki-update-to-1-0-help-needed/3303)
**Author:** [@d.j.a.y](https://forums.synfig.org/u/d.j.a.y)\ **Replies:** 22\ **Last updated:** [September 4, 2015, 12:02pm UTC](https://forums.synfig.org/t/wiki-update-to-1-0-help-needed/3303 "2015-09-04T12:02:10Z")
Hello all … In order to have a compliant documentation for the 1.0 release, the project need your help to update the documetation. You can help… Even drafting some new sentences / pages , taking screenshots … wiki.synf… --- ## [Output location stored in .sif file](https://forums.synfig.org/t/output-location-stored-in-sif-file/3502)
**Author:** [@Dave\_Hingley](https://forums.synfig.org/u/Dave_Hingley)\ **Replies:** 1\ **Last updated:** [July 28, 2015, 7:00am UTC](https://forums.synfig.org/t/output-location-stored-in-sif-file/3502 "2015-07-28T07:00:45Z")
when clicking the render button of a synfig file. it seems to default to the location of the the .sif file. Am i right in thinking that the output settings are not stored with the .sif file? --- ## [Synfig pdf manual](https://forums.synfig.org/t/synfig-pdf-manual/3439)
**Author:** [@Darkspace\_be](https://forums.synfig.org/u/Darkspace_be)\ **Replies:** 3\ **Last updated:** [May 29, 2015, 11:33am UTC](https://forums.synfig.org/t/synfig-pdf-manual/3439 "2015-05-29T11:33:44Z")
Hi! I decided to update the pdf manual snapshot to Synfig 1.0 using openOffice. It’s still work in progress. To do: fish out mistakes and errors or outdated information. Place the right caption under the right picture.… [Next page](https://forums.synfig.org/c/development/documentation/30.md?page=1)