Hello everyone!
We are preparing the release of new version of Synfig. After a long discussion it was decided that many things will have different names in the new version. That means introducing the new terminology
Here’s the list of changes:
- Duck → Handle (edited on 12.01.2013)
- Curves Panel → Graphs Panel
- Encapsulate → Group (icon needs to be reworked: box or folder)
- Paste Canvas / Inline Canvas layer → Group layer (icon needs to be reworked: same as above)
- Group → Set (icon needs to be reworked)
- Add/remove from Group->Add/remove from Set (icon needs to be reworked)
- BLine → Spline
- BLine Point → Spline Point
- BLine Tool → Spline Tool
- Params Panel → Parameters Panel
- Children Panel → Library Panel
- CPoint → Color Stop
Now we need to update the documentation pages before release and that’s why we are running that sprint.
We have revision approval enabled for the wiki. It means that no changes will be visible on the wiki until they will get approved by moderators. That allows us to safely rewrite documentation pages for the new terminology, but keep those changes hidden until the new version of Synfig will be released.
So, moderators should NOT approve revisions containing the new terminology until the release.
You can download the binary packages with the new terminology here:
http://download.tuxfamily.org/synfig/packages/binaries/
To organize our work on updating documentation we will use following workflow:
- Select page to rewrite and assign it to yourself
-
Go to wiki.synfig.org/wiki/Dev:Sprints … erminology and see the list of pages pending for rewrite. Decide for yourself which page you will be working on. Please ignore the pages having some username (inside of “<” and “>” symbols) after the title - that means someone is already rewriting this page now.
-
You need to mark the chosen page as assigned to you. Please edit the list of pending pages and add your username near the title, surrounded by “<” and “>” symbols. Example: wiki.synfig.org/wiki/index.php?t … ldid=16615
- Rewrite the page
-
Open chosen page. Go to edit mode.
-
Now you have to carefully rewrite the page by doing search operation and replacing the found terms with new ones. Please take your time to replace carefully and check if your modifications fit the cotext. Make sure to do search in case insensetive mode. The search requests:
** “duck” (replace to “handle”)
** “bline” (replace with “spline”)
** “cpoint” (replase with “color stop”)
** “curves” (replace with “graphs”, but only IF it’s about “Curves Panel”)
** “group” (replace to “set”, but only IF the context is related with “Groups Panel” functionality)
** “params” (replace with “parameters” if it’s about “Params Panel”).
** “child” (replace “child” or “children” with “library” if it’s about “Child Panel” or “Children Panel”. Please don’t confuse with “Children Lock”)
- When all the terms above are replaced then you have to replace the next ones (please make sure that you have those replacements only after all termins in previous step are replaced):
** “encapsul” (replace “Encapsulated”/“Encapsulation”/etc with “Group”)
** “paste” (replace mentions of “Paste Canvas” into “Group”)
** “inlin” (replace mentions of “Inline Canvas” with “Group”)
- Add the {{NewTerminology}} at the top of the page. We need that because it is possible that while we doing that sprint someone will add the new pages to the wiki. Surely the newly added page won’t be listed at wiki.synfig.org/wiki/Dev:Sprints … erminology and thus it won’t be updated. But if we have all updated pages marked with {{NewTerminology}}, then after the sprint will be finished we can filter the pages and see if there are any pages we have skipped.
NOTE: Please add the {{NewTerminology}} even if page have no matching words to replace. That way it is marked as done.
-
Please specify following summary for your revision: “Terminology Updated”. That will allow approval moderators to identify your edit as related with new terminology.
-
Preview your changes. Read the edited page from start to the end to ensure that it’s readable smoothly with new terminology. Correct the mistakes if found.
-
Save page.
Example of edited page: wiki.synfig.org/wiki/index.php?t … ldid=16614
- If the page title contains any of the terms above to replace, then rename (move) page accordingly. Don’t worry, moving page won’t get effect until it will be approved.
- Mark the page as rewritten
-
Now go back to step 1.
NOTE: I don’t see the reason to rename image files for now. The filenames aren’t visible anyway. And I believe they will be replaced when all screenshots will be updated, right?
EDIT 2013-02-05: If you willing to update images as well, then Carlos have a good advice:
)
