qgis / QGIS-Documentation

QGIS Documentation
https://docs.qgis.org/latest
460 stars 680 forks source link

Should We Include Blank Space for Notes/Answers? #196

Closed grvhi closed 10 years ago

grvhi commented 10 years ago

@jj0hns0n has included left in (in his excellent re-write of the database-related modules) blank space for end-users to hand-write solutions to questions: is this something we want to do throughout the docs? Or should we use the "Check Your Results" links to link to an explained answer on the answers page (as per current)?

My feeling is that this is a training rather than testing manual and that the white space impacts the layout and usability of the docs, especially when rendered in HTML.

However, a lot of the questions relate to structuring SQL queries and allowing the end-user to hand-write possible solutions could be very helpful.

CC

@timlinux @rduivenvoorde

Update

As pointed out by @jj0hns0n, the blank spaces were already there, so the proposition is that we remove them and replace with "Check Your Results" links.

pcav commented 10 years ago

No blank space forma me

George Irwin notifications@github.com ha scritto:

@jj0hns0n has included (in his excellent re-write of the database-related modules) blank space for end-users to hand-write solutions to questions: is this something we want to do throughout the docs? Or should we use the "Check Your Results" links to link to an explained answer on the answers page (as per current)?

My feeling is that this is a training rather than testing manual and that the white space impacts the layout and usability of the docs, especially when rendered in HTML.

However, a lot of the questions relate to structuring SQL queries and allowing the end-user to hand-write possible solutions could be very helpful.

CC

@timlinux @rduivenvoorde


Reply to this email directly or view it on GitHub: https://github.com/qgis/QGIS-Documentation/issues/196

http://faunalia.eu/

jj0hns0n commented 10 years ago

Those were already there. I just left them in. They do seem both a bit odd yet potentially useful.

On Jan 11, 2014, at 1:52, George Irwin notifications@github.com wrote:

@jj0hns0n has included (in his excellent re-write of the database-related modules) blank space for end-users to hand-write solutions to questions: is this something we want to do throughout the docs? Or should we use the "Check Your Results" links to link to an explained answer on the answers page (as per current)?

My feeling is that this is a training rather than testing manual and that the white space impacts the layout and usability of the docs, especially when rendered in HTML.

However, a lot of the questions relate to structuring SQL queries and allowing the end-user to hand-write possible solutions could be very helpful.

CC

@timlinux @rduivenvoorde

— Reply to this email directly or view it on GitHub.

jj0hns0n commented 10 years ago

Git blame is not very helpful in finding out who added them, but Im +1 on removing them. Can do it now if everyone agrees.

grvhi commented 10 years ago

@jj0hns0n - I think it's a sound yes on removing them and replacing with helpful explanations in the answers section (although most have answers already).

jj0hns0n commented 10 years ago

Looks like you already removed a bunch. I can do the rest, or feel free.

On Sat, Jan 11, 2014 at 8:17 AM, George Irwin notifications@github.comwrote:

@jj0hns0n https://github.com/jj0hns0n - I think it's a sound yes on removing them and replacing with helpful explanations in the answers section (although most have answers already).

— Reply to this email directly or view it on GitHubhttps://github.com/qgis/QGIS-Documentation/issues/196#issuecomment-32099936 .

grvhi commented 10 years ago

Yup, I took out a couple - happy to carry on with the rest.

On 11 Jan 2014, at 19:52 , Jeffrey Johnson notifications@github.com wrote:

Looks like you already removed a bunch. I can do the rest, or feel free.

On Sat, Jan 11, 2014 at 8:17 AM, George Irwin notifications@github.comwrote:

@jj0hns0n https://github.com/jj0hns0n - I think it's a sound yes on removing them and replacing with helpful explanations in the answers section (although most have answers already).

— Reply to this email directly or view it on GitHubhttps://github.com/qgis/QGIS-Documentation/issues/196#issuecomment-32099936 .

— Reply to this email directly or view it on GitHub.

timlinux commented 10 years ago

Hi

+1 - I put them in in the original text I wrote for the database stuff but that preceded the other bits of the training manual and we dropped using it in the newser stuff because it kills trees when you print the manual out...

Regards

Tim

On Sat, Jan 11, 2014 at 8:15 PM, George Irwin notifications@github.comwrote:

Yup, I took out a couple - happy to carry on with the rest.

On 11 Jan 2014, at 19:52 , Jeffrey Johnson notifications@github.com wrote:

Looks like you already removed a bunch. I can do the rest, or feel free.

On Sat, Jan 11, 2014 at 8:17 AM, George Irwin notifications@github.comwrote:

@jj0hns0n https://github.com/jj0hns0n - I think it's a sound yes on removing them and replacing with helpful explanations in the answers section (although most have answers already).

— Reply to this email directly or view it on GitHub< https://github.com/qgis/QGIS-Documentation/issues/196#issuecomment-32099936>

.

— Reply to this email directly or view it on GitHub.

— Reply to this email directly or view it on GitHubhttps://github.com/qgis/QGIS-Documentation/issues/196#issuecomment-32102921 .

Tim Sutton - QGIS Project Steering Committee Member

Visit http://linfiniti.com to find out about: