Hi Friends, I think Maren mentioned to Carl about terminology (in a different message) and I agree that one of the most important things we need to do, is use the same terminology throughout the manual. However, that said, I'm not sure what the best way to accomplish that would be.
Actually I was going to propose some changes to some of the section and chapter titles, in this message. But now that I think about it, that might be putting the cart before the horse (as we say here, sometimes).
Should we create a Glossary? I mean as part of the manual? Or should we create a glossary that we just use for our own reference, as we write? Maybe make it part of the wiki? The gitlab wiki?
Once or twice I've had a thought about making a glossary for the website someday. But until the website contains more instructional info, it probably has no purpose yet. But what I mean is that creating a glossary, whether formally part of the manual, or just in the wiki, could also be used on the website someday.
If not glossary, what are some other ways we could keep ourselves all on the same page regarding terminology? What about one person (or 2?) who primarily takes care of that? Other ideas?
All best, brynn
On Thu, May 18, 2017 at 11:55 AM, brynn <brynn@...78...> wrote:
Hi Friends, I think Maren mentioned to Carl about terminology (in a different message) and I agree that one of the most important things we need to do, is use the same terminology throughout the manual. However, that said, I'm not sure what the best way to accomplish that would be.
This is an excellent suggestion for high level consistency as well.
Actually I was going to propose some changes to some of the section andchapter titles, in this message. But now that I think about it, that might be putting the cart before the horse (as we say here, sometimes).
Should we create a Glossary? I mean as part of the manual? Or shouldwe create a glossary that we just use for our own reference, as we write? Maybe make it part of the wiki? The gitlab wiki?
Yes, a Glossary would be helpful in the manual. It would be useful as the manual is written; almost essential when beginners are using Inkscape. Probably good in a wiki, perhaps after the manual is complete to maintain consistency.
Once or twice I've had a thought about making a glossary for the websitesomeday. But until the website contains more instructional info, it probably has no purpose yet. But what I mean is that creating a glossary, whether formally part of the manual, or just in the wiki, could also be used on the website someday.
Yes.
If not glossary, what are some other ways we could keep ourselves all onthe same page regarding terminology? What about one person (or 2?) who primarily takes care of that? Other ideas?
It's likely that the people writing have some idea of what any terms mean. So it would work for people to write using their own terms (for example, I don't plan to write technical stuff about anything that I don't understand. So in situations where the material is too advanced for me, I'll only edit grammar, spelling and clarity, depending on others who are more knowledgeable to provide the technical details). Some smart person can come back and make terminology consistent throughout the manual. I think that would be better than for people to try to learn proper terminology first.
This also applies to the style of writing throughout the document. Several people will be writing--and they should be writing in a way that is comfortable to them. A final editing task will be to revisit the document as a whole and make the style consistent.
Carl
All best, brynn
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Hi Brynn, Carl + all manual editors,
having a glossary at the end of the Beginners' guide sounds like a nice idea. Also makes for a good place to link to, from various places in the book.
Unfortunately, we cannot copy-paste from http://wiki.inkscape.org/wiki/index.php/Inkscape_glossary, to get a quickstart, because of licensing reasons, but we should stick to the terminology that is used there, which is the canonical way to name things for Inkscape.
Kind Regards, Maren
Am 18.05.2017 um 22:37 schrieb Carl Symons:
On Thu, May 18, 2017 at 11:55 AM, brynn <brynn@...78...> wrote:
Hi Friends, I think Maren mentioned to Carl about terminology (in a different message) and I agree that one of the most important things we need to do, is use the same terminology throughout the manual. However, that said, I'm not sure what the best way to accomplish that would be.
This is an excellent suggestion for high level consistency as well.
Actually I was going to propose some changes to some of the section andchapter titles, in this message. But now that I think about it, that might be putting the cart before the horse (as we say here, sometimes).
Should we create a Glossary? I mean as part of the manual? Or shouldwe create a glossary that we just use for our own reference, as we write? Maybe make it part of the wiki? The gitlab wiki?
Yes, a Glossary would be helpful in the manual. It would be useful as the manual is written; almost essential when beginners are using Inkscape. Probably good in a wiki, perhaps after the manual is complete to maintain consistency.
Once or twice I've had a thought about making a glossary for the websitesomeday. But until the website contains more instructional info, it probably has no purpose yet. But what I mean is that creating a glossary, whether formally part of the manual, or just in the wiki, could also be used on the website someday.
Yes.
If not glossary, what are some other ways we could keep ourselves all onthe same page regarding terminology? What about one person (or 2?) who primarily takes care of that? Other ideas?
It's likely that the people writing have some idea of what any terms mean. So it would work for people to write using their own terms (for example, I don't plan to write technical stuff about anything that I don't understand. So in situations where the material is too advanced for me, I'll only edit grammar, spelling and clarity, depending on others who are more knowledgeable to provide the technical details). Some smart person can come back and make terminology consistent throughout the manual. I think that would be better than for people to try to learn proper terminology first.
This also applies to the style of writing throughout the document. Several people will be writing--and they should be writing in a way that is comfortable to them. A final editing task will be to revisit the document as a whole and make the style consistent.
Carl
All best, brynn
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Thanks, Maren.
I didn't realize there was a license for the wiki. It looks like it has a GNU GPL license. Why can't we use it? Is it because the manual license doesn't have share alike?
Well, first I'll work on the images/image titles, since I agreed to that first. But once I get a good start on that, I'll start working on a glossary. I mean, the wiki doesn't have any control over definitions - just the particular arrangement of words that are used. So it should be easy enough make definitions that work, without violating the license. And if the manual glossary has different words than the wiki, that should go even further to make them unalike.
But one step at a time!
All best, brynn
-----Original Message----- From: Maren Hachmann Sent: Saturday, May 20, 2017 5:10 AM To: inkscape-docs@lists.sourceforge.net Subject: Re: [Inkscape-docs] [Manual] Terminology
Hi Brynn, Carl + all manual editors,
having a glossary at the end of the Beginners' guide sounds like a nice idea. Also makes for a good place to link to, from various places in the book.
Unfortunately, we cannot copy-paste from http://wiki.inkscape.org/wiki/index.php/Inkscape_glossary, to get a quickstart, because of licensing reasons, but we should stick to the terminology that is used there, which is the canonical way to name things for Inkscape.
Kind Regards, Maren
Am 18.05.2017 um 22:37 schrieb Carl Symons:
On Thu, May 18, 2017 at 11:55 AM, brynn <brynn@...78...> wrote:
Hi Friends, I think Maren mentioned to Carl about terminology (in a different message) and I agree that one of the most important things we need to do, is use the same terminology throughout the manual. However, that said, I'm not sure what the best way to accomplish that would be.
This is an excellent suggestion for high level consistency as well.
Actually I was going to propose some changes to some of the sectionand chapter titles, in this message. But now that I think about it, that might be putting the cart before the horse (as we say here, sometimes).
Should we create a Glossary? I mean as part of the manual? Orshould we create a glossary that we just use for our own reference, as we write? Maybe make it part of the wiki? The gitlab wiki?
Yes, a Glossary would be helpful in the manual. It would be useful as the manual is written; almost essential when beginners are using Inkscape. Probably good in a wiki, perhaps after the manual is complete to maintain consistency.
Once or twice I've had a thought about making a glossary for thewebsite someday. But until the website contains more instructional info, it probably has no purpose yet. But what I mean is that creating a glossary, whether formally part of the manual, or just in the wiki, could also be used on the website someday.
Yes.
If not glossary, what are some other ways we could keep ourselves allon the same page regarding terminology? What about one person (or 2?) who primarily takes care of that? Other ideas?
It's likely that the people writing have some idea of what any terms mean. So it would work for people to write using their own terms (for example, I don't plan to write technical stuff about anything that I don't understand. So in situations where the material is too advanced for me, I'll only edit grammar, spelling and clarity, depending on others who are more knowledgeable to provide the technical details). Some smart person can come back and make terminology consistent throughout the manual. I think that would be better than for people to try to learn proper terminology first.
This also applies to the style of writing throughout the document. Several people will be writing--and they should be writing in a way that is comfortable to them. A final editing task will be to revisit the document as a whole and make the style consistent.
Carl
All best, brynn
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
On Mon, 2017-05-22 at 12:23 -0600, brynn wrote:
Unfortunately, we cannot copy-paste from http://wiki.inkscape.org/wiki/index.php/Inkscape_glossary, to get a quickstart, because of licensing reasons, but we should stick to the terminology that is used there, which is the canonical way to name things for Inkscape.
Although you can copy the list itself (without descriptions), since lists of things documenting something isn't copyrightable. (It's data)
But that's up to you if you want to use it as a skelington.
Martin,
Thank you, all of you, for putting in quality time, thought, and discussion on The Manual. I've been using an ad hoc terminology for some of Inkscape's functions in my tutorial and would like to bring my language into accordance with what you are designing. I invite you to use anything in the tutorial that might add to or complement your work. The tutorial is at:
https://roy-torley.github.io/Inkscape_Tutorial/Inkscape_Tutorial_Contents.ht...
I still have to Bootstrap individual lessons, but the content should be decent (good enough for government use?).
Yours with support,
Roy Torley
Hi Friends, I think Maren mentioned to Carl about terminology (in a different message) and I agree that one of the most important things we need to do, is use the same terminology throughout the manual. However, that said, I'm not sure what the best way to accomplish that would be.
Actually I was going to propose some changes to some of thesection and chapter titles, in this message. But now that I think about it, that might be putting the cart before the horse (as we say here, sometimes).
Should we create a Glossary? I mean as part of the manual? Orshould we create a glossary that we just use for our own reference, as we write? Maybe make it part of the wiki? The gitlab wiki?
Once or twice I've had a thought about making a glossary for thewebsite someday. But until the website contains more instructional info, it probably has no purpose yet. But what I mean is that creating a glossary, whether formally part of the manual, or just in the wiki, could also be used on the website someday.
If not glossary, what are some other ways we could keep ourselvesall on the same page regarding terminology? What about one person (or 2?) who primarily takes care of that? Other ideas?
All best, brynn
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Hi Roy and everyone,
thank you for allowing us to draw from your tutorials.
For adapting your terminology, I'd like to refer you to the Inkscape Wiki at http://wiki.inkscape.org/wiki/index.php/Inkscape_glossary.
If you like, you can also join us in editing the manual directly.
We do right now - aside from translators - have a need for people who:
- can polish the English - can take care of a more homogenous structuring of each chapter - can make screenshots of an English version, and put the image descriptions right beside the corresponding screenshots (they are currently all lumped together). - can rename + reupload + relink the good screenshots to use English file names - can check links in translated parts, and add meaningful hover texts to them, and also make them open in a new tab/window, so the user doesn't leave the manual altogether when clicking on them - can rewrite the outdated chapter about keyboard shortcuts - possibly: can write a chapter about the Align+Distribute dialog - possibly: can suggest some useful changes to the Inkscape preferences that help new users - possibly: can write a short chapter about Inkscape installation - possibly: can write a short chapter about where to get further help + learn more - can curate the proposed glossary
Anyone who reads this: You can pick a task that you feel comfortable with, and start right away :)
Kind Regards, Maren
Am 18.05.2017 um 23:40 schrieb bandura1@...114...:
Thank you, all of you, for putting in quality time, thought, and discussion on The Manual. I've been using an ad hoc terminology for some of Inkscape's functions in my tutorial and would like to bring my language into accordance with what you are designing. I invite you to use anything in the tutorial that might add to or complement your work. The tutorial is at:
https://roy-torley.github.io/Inkscape_Tutorial/Inkscape_Tutorial_Contents.ht...
I still have to Bootstrap individual lessons, but the content should be decent (good enough for government use?).
Yours with support,
Roy Torley
Hi Friends, I think Maren mentioned to Carl about terminology (in a different message) and I agree that one of the most important things we need to do, is use the same terminology throughout the manual. However, that said, I'm not sure what the best way to accomplish that would be.
Actually I was going to propose some changes to some of thesection and chapter titles, in this message. But now that I think about it, that might be putting the cart before the horse (as we say here, sometimes).
Should we create a Glossary? I mean as part of the manual? Orshould we create a glossary that we just use for our own reference, as we write? Maybe make it part of the wiki? The gitlab wiki?
Once or twice I've had a thought about making a glossary for thewebsite someday. But until the website contains more instructional info, it probably has no purpose yet. But what I mean is that creating a glossary, whether formally part of the manual, or just in the wiki, could also be used on the website someday.
If not glossary, what are some other ways we could keep ourselvesall on the same page regarding terminology? What about one person (or 2?) who primarily takes care of that? Other ideas?
All best, brynn
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
participants (5)
-
unknown＠example.com -
brynn -
Carl Symons -
Maren Hachmann -
Martin Owens