Difference between revisions of "Doc talk:Getting Started"
From Synfig Studio :: Documentation
m |
m (Rewrite preparation for 0.65) |
||
| (43 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == Rewrite preparation for 0.65 == | |
| + | |||
| + | global review needed ! | ||
| + | |||
| + | |||
| + | == new doc == | ||
| + | * <s>Read through the page, checking if all recommendation applicable to latest synfig version.</s> | ||
| + | * <s>Update screenshots (remember, that in mediawiki you can upload new version of the same file, no need to invent new filename)</s> | ||
| + | * <s>Ensure that page using proper templates, i.e.:</s> | ||
| + | ** <s>Title and Navigation is set at the top</s> | ||
| + | ** <s>For menu invocations use "c" template. i.e. {{c|File|Save}} will be transformed into File -> Save. That way we will be able to keep formating of menu invocation consistent across the whole doc. And maybe implement some auto-translation later...</s> | ||
| + | ** <s>Think about other templates we may need, i.e.: Warning, Note...</s> | ||
| + | * <s>After that set <nowiki>{{Category|Updated}}</nowiki> for this page. --[[User:Zelgadis|Zelgadis]] 15:04, 14 April 2010 (UTC)</s> | ||
| + | * Upload sources for screenshots --[[User:Zelgadis|Zelgadis]] | ||
| + | |||
| + | == Doc Toughts == | ||
| + | '''Structure''' | ||
| + | * I recently moved the "first step" title a bit below, making a new technical section ("under the hood") explicit instead of hidden in first step. If this kind of "major" modification is better left for later please tell me at http://synfig.org/forums/viewtopic.php?f=25&t=1121&start=0&st=0&sk=t&sd=a for me not to mess with pages marked "up to date"! the content was already there... but it just felt wrong to get internal layers info when expecting "first steps" --[[User:Berteh|Berteh]] 13:56, 20 May 2010 (UTC) | ||
| + | ** Looks good. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | |||
| + | |||
| + | '''Impression:''' | ||
| + | * much better beginning now! congrats! ;-) --[[User:Ohoservices|Ohoservices]] 09:55, 20 April 2010 (UTC) | ||
| + | * I like the new pic style (with frame, name and ref) --[[User:Ohoservices|Ohoservices]] 09:59, 20 April 2010 (UTC) | ||
| + | * I'd like introduction documents as this one to have more images to look more fancy. I'd suggest adding (at least) the icon of each panel (no screenshot, just the icon), for instance, inline in the text or left (floated). --[[User:Berteh|Berteh]] 13:04, 20 May 2010 (UTC) | ||
| + | ** If we have those icone inline in the text then there will be problems with pdf export. I can tune that case, but don't think it's really necessary. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | |||
| + | '''Possible changes:''' | ||
| + | to be decided/discussed about | ||
| + | * <s>screenshot of "layers panel" is scary. maybe use File:Adding-layers-tutorial-12.png instead? </s> --[[User:Berteh|Berteh]] 13:21, 20 May 2010 (UTC) | ||
| + | ** Good idea. Replaced. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * Some info are not of "introduction" level... I'd suggest getting rid of these here... and put them in the more detailed "reference" pages --[[User:Berteh|Berteh]] 13:04, 20 May 2010 (UTC) | ||
| + | ** Each time you start Synfig Studio, a new Canvas Window is opened.<s> This window represents the {{l|Root Canvas}}, not that that means much to you at the moment, but</s> that's OK — We're just trying to show you around. | ||
| + | *** Makes sense, but that's a hint for the future that we can have multiple canvases. Let's leave as is for now. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | ** {{l|Params Panel}} — This panel shows you the parameters of the layer currently selected. <s>When multiple layers are selected, only the parameters that the selected layers have in common are displayed.</s> | ||
| + | *** That's useful hint for editing bunch of layers. Leaving as is for now. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * Layers should just show a few layers for the beginning and it should be discussed after the user has created some objects that show up as layers so that he/she can experinece what we describe. --[[User:Ohoservices|Ohoservices]] 09:55, 20 April 2010 (UTC) | ||
| + | ** Which part of the text you referring to? --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * <s>at the end we should say next "chapter", not "tutorial" as we are not in the tutorials section here.</s> --[[User:Ohoservices|Ohoservices]] 09:55, 20 April 2010 (UTC) | ||
| + | ** fixed to "section", considering the whole book structure. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * Text under "Development notes" should go to some introduction chapter probably. "Functional overview of Synfig" maybe? (see [http://mind42.com/pub/mindmap?mid=37e14959-ad60-4e7a-9e34-8363a8d97af1 1]) --[[User:Zelgadis|Zelgadis]] 15:39, 17 April 2010 (UTC) | ||
| + | ** I would remove development notes completely, maybe move to end of doc as "synfig future" or so --[[User:Ohoservices|Ohoservices]] 09:55, 20 April 2010 (UTC) | ||
| + | ** I moved it to "First steps" for now. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * <s>Replace "CONTROL key" with template.</s> --[[User:Zelgadis|Zelgadis]] 15:39, 17 April 2010 (UTC) | ||
| + | * the note about the problem with input devices: is that on Linux only? if so: then we should mention that, later we should copy that to installation chapter maybe just leaving a link here. Does that go away with 0.62.xx? --[[User:Ohoservices|Ohoservices]] 09:55, 20 April 2010 (UTC) | ||
| + | ** In 0.62.01 all devices are disabled by default - so should not be a problem anymore. Don't know about Windows. Moving somewhere looks like a good idea. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * autorecover feature should be moved to "functional Overview" as well later on --[[User:Ohoservices|Ohoservices]] 09:55, 20 April 2010 (UTC) | ||
| + | ** Moved as note to the "First steps" for now. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * <s>"Linking" should be split in "Linking" and "Color selection"</s> --[[User:Ohoservices|Ohoservices]] 10:05, 20 April 2010 (UTC) | ||
| + | * <s>maybe also we can add how to change colors by using the "Params" Panel, would fit quite nicely...</s> --[[User:Ohoservices|Ohoservices]] 10:08, 20 April 2010 (UTC) | ||
| + | * <s>Color: Foreground/Background should be renamed to Fill/Outline</s> --[[User:Ohoservices|Ohoservices]] 10:05, 20 April 2010 (UTC) | ||
| + | * All parts should be illustrated much more, a beginner likes to have some pics to verify he/she is doing well... --[[User:Ohoservices|Ohoservices]] 10:05, 20 April 2010 (UTC) | ||
| + | ** Images welcome. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * <s>Navigation "<<" leads to "Synfig vs. Synfig Studio". Should we remove that? I think so.</s> --[[User:Ohoservices|Ohoservices]] 10:13, 20 April 2010 (UTC) | ||
| + | * <s>Add and use "Literal" template</s> --[[User:Zelgadis|Zelgadis]] 14:51, 21 April 2010 (UTC) | ||
| + | * can we make the notes boxes as wide as the rest of the doc? currently they appear smaller and centered. --[[User:Ohoservices|Ohoservices]] 22:45, 21 April 2010 (UTC) | ||
| + | ** We can, but I think that way they look better on the page. Blender uses same formatting for notes. --[[User:Zelgadis|Zelgadis]] 06:23, 5 May 2010 (UTC) | ||
| + | |||
| + | '''Fixes needed''' | ||
| + | ''dead links'' | ||
| + | * <s>link to "Toolbox" should go to "Category:Toolbox"</s> --[[User:Ohoservices|Ohoservices]] 21:58, 17 May 2010 (UTC) | ||
| + | ** It's ok as long as there's redirection from "Toolbox" to "Category:Toolbox" --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * <s>link to "Panels" should go to "Category:Panels"</s> --[[User:Ohoservices|Ohoservices]] 21:51, 17 May 2010 (UTC) | ||
| + | ** Redirect page created --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * link to "Canvas Window" and "Root Canvas" should use the "Canvas" link as well... right? --[[User:Ohoservices|Ohoservices]] 21:58, 17 May 2010 (UTC) | ||
| + | ** No. Those are separate concepts. | ||
| + | * <s>"bounding box" link (remove or add doc page)</s> --[[User:Ohoservices|Ohoservices]] 21:58, 17 May 2010 (UTC) | ||
| + | ** Removed. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
| + | * <s>"selection box" link (remove or add doc page)</s> --[[User:Ohoservices|Ohoservices]] 21:59, 17 May 2010 (UTC) | ||
| + | ** Removed. --[[User:Zelgadis|Zelgadis]] 09:13, 19 August 2010 (UTC) | ||
Latest revision as of 10:01, 22 March 2014
Rewrite preparation for 0.65
global review needed !
new doc
-
Read through the page, checking if all recommendation applicable to latest synfig version. -
Update screenshots (remember, that in mediawiki you can upload new version of the same file, no need to invent new filename) -
Ensure that page using proper templates, i.e.:-
Title and Navigation is set at the top -
For menu invocations use "c" template. i.e. "File → Save" will be transformed into File -> Save. That way we will be able to keep formating of menu invocation consistent across the whole doc. And maybe implement some auto-translation later... -
Think about other templates we may need, i.e.: Warning, Note...
-
-
After that set {{Category|Updated}} for this page. --Zelgadis 15:04, 14 April 2010 (UTC) - Upload sources for screenshots --Zelgadis
Doc Toughts
Structure
- I recently moved the "first step" title a bit below, making a new technical section ("under the hood") explicit instead of hidden in first step. If this kind of "major" modification is better left for later please tell me at http://synfig.org/forums/viewtopic.php?f=25&t=1121&start=0&st=0&sk=t&sd=a for me not to mess with pages marked "up to date"! the content was already there... but it just felt wrong to get internal layers info when expecting "first steps" --Berteh 13:56, 20 May 2010 (UTC)
- Looks good. --Zelgadis 09:13, 19 August 2010 (UTC)
Impression:
- much better beginning now! congrats! ;-) --Ohoservices 09:55, 20 April 2010 (UTC)
- I like the new pic style (with frame, name and ref) --Ohoservices 09:59, 20 April 2010 (UTC)
- I'd like introduction documents as this one to have more images to look more fancy. I'd suggest adding (at least) the icon of each panel (no screenshot, just the icon), for instance, inline in the text or left (floated). --Berteh 13:04, 20 May 2010 (UTC)
- If we have those icone inline in the text then there will be problems with pdf export. I can tune that case, but don't think it's really necessary. --Zelgadis 09:13, 19 August 2010 (UTC)
Possible changes: to be decided/discussed about
-
screenshot of "layers panel" is scary. maybe use File:Adding-layers-tutorial-12.png instead?--Berteh 13:21, 20 May 2010 (UTC)- Good idea. Replaced. --Zelgadis 09:13, 19 August 2010 (UTC)
- Some info are not of "introduction" level... I'd suggest getting rid of these here... and put them in the more detailed "reference" pages --Berteh 13:04, 20 May 2010 (UTC)
- Each time you start Synfig Studio, a new Canvas Window is opened.
This window represents the Root Canvas, not that that means much to you at the moment, butthat's OK — We're just trying to show you around.- Makes sense, but that's a hint for the future that we can have multiple canvases. Let's leave as is for now. --Zelgadis 09:13, 19 August 2010 (UTC)
- Params Panel — This panel shows you the parameters of the layer currently selected.
When multiple layers are selected, only the parameters that the selected layers have in common are displayed.- That's useful hint for editing bunch of layers. Leaving as is for now. --Zelgadis 09:13, 19 August 2010 (UTC)
- Each time you start Synfig Studio, a new Canvas Window is opened.
- Layers should just show a few layers for the beginning and it should be discussed after the user has created some objects that show up as layers so that he/she can experinece what we describe. --Ohoservices 09:55, 20 April 2010 (UTC)
- Which part of the text you referring to? --Zelgadis 09:13, 19 August 2010 (UTC)
-
at the end we should say next "chapter", not "tutorial" as we are not in the tutorials section here.--Ohoservices 09:55, 20 April 2010 (UTC)- fixed to "section", considering the whole book structure. --Zelgadis 09:13, 19 August 2010 (UTC)
- Text under "Development notes" should go to some introduction chapter probably. "Functional overview of Synfig" maybe? (see 1) --Zelgadis 15:39, 17 April 2010 (UTC)
- I would remove development notes completely, maybe move to end of doc as "synfig future" or so --Ohoservices 09:55, 20 April 2010 (UTC)
- I moved it to "First steps" for now. --Zelgadis 09:13, 19 August 2010 (UTC)
-
Replace "CONTROL key" with template.--Zelgadis 15:39, 17 April 2010 (UTC) - the note about the problem with input devices: is that on Linux only? if so: then we should mention that, later we should copy that to installation chapter maybe just leaving a link here. Does that go away with 0.62.xx? --Ohoservices 09:55, 20 April 2010 (UTC)
- In 0.62.01 all devices are disabled by default - so should not be a problem anymore. Don't know about Windows. Moving somewhere looks like a good idea. --Zelgadis 09:13, 19 August 2010 (UTC)
- autorecover feature should be moved to "functional Overview" as well later on --Ohoservices 09:55, 20 April 2010 (UTC)
- Moved as note to the "First steps" for now. --Zelgadis 09:13, 19 August 2010 (UTC)
-
"Linking" should be split in "Linking" and "Color selection"--Ohoservices 10:05, 20 April 2010 (UTC) -
maybe also we can add how to change colors by using the "Params" Panel, would fit quite nicely...--Ohoservices 10:08, 20 April 2010 (UTC) -
Color: Foreground/Background should be renamed to Fill/Outline--Ohoservices 10:05, 20 April 2010 (UTC) - All parts should be illustrated much more, a beginner likes to have some pics to verify he/she is doing well... --Ohoservices 10:05, 20 April 2010 (UTC)
- Images welcome. --Zelgadis 09:13, 19 August 2010 (UTC)
-
Navigation "<<" leads to "Synfig vs. Synfig Studio". Should we remove that? I think so.--Ohoservices 10:13, 20 April 2010 (UTC) -
Add and use "Literal" template--Zelgadis 14:51, 21 April 2010 (UTC) - can we make the notes boxes as wide as the rest of the doc? currently they appear smaller and centered. --Ohoservices 22:45, 21 April 2010 (UTC)
- We can, but I think that way they look better on the page. Blender uses same formatting for notes. --Zelgadis 06:23, 5 May 2010 (UTC)
Fixes needed dead links
-
link to "Toolbox" should go to "Category:Toolbox"--Ohoservices 21:58, 17 May 2010 (UTC)- It's ok as long as there's redirection from "Toolbox" to "Category:Toolbox" --Zelgadis 09:13, 19 August 2010 (UTC)
-
link to "Panels" should go to "Category:Panels"--Ohoservices 21:51, 17 May 2010 (UTC)- Redirect page created --Zelgadis 09:13, 19 August 2010 (UTC)
- link to "Canvas Window" and "Root Canvas" should use the "Canvas" link as well... right? --Ohoservices 21:58, 17 May 2010 (UTC)
- No. Those are separate concepts.
-
"bounding box" link (remove or add doc page)--Ohoservices 21:58, 17 May 2010 (UTC)- Removed. --Zelgadis 09:13, 19 August 2010 (UTC)
-
"selection box" link (remove or add doc page)--Ohoservices 21:59, 17 May 2010 (UTC)- Removed. --Zelgadis 09:13, 19 August 2010 (UTC)
