Project: User Guide tech edit

Working group for improving LiveCode's User Guide, Dictionary, and other learning resorces.

Moderators: Klaus, FourthWorld, heatherlaine, kevinmiller, robinmiller

Project: User Guide tech edit

Postby FourthWorld » Sat May 24, 2014 4:23 pm

The User Guide needs a review and some minor modifications to make sure it's current with LiveCode 7.0. Not only will this be valuable for everyone using LiveCode, but it's an essential first step for any projects involving translating the User Guide to other languages, like the team already in place to handle a Spanish translation.

Anyone interested in helping this project is encouraged to chime in here, and in the meantime I'm working with the documentation team at RunRev to make sure we get the necessary source files (word processor documents) needed to make this happen.
Richard Gaskin
Community volunteer LiveCode Community Liaison

LiveCode development, training, and consulting services: Fourth World Systems: http://FourthWorld.com
LiveCode User Group on Facebook : http://FaceBook.com/groups/LiveCodeUsers/
FourthWorld
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
 
Posts: 5305
Joined: Sat Apr 08, 2006 7:05 am
Location: Los Angeles

Re: Project: User Guide tech edit

Postby DanShafer » Fri Jun 06, 2014 8:55 am

Richard,

I'd be willing and eager to help with this effort assuming it comes to fruition.

Dan
DanShafer
Livecode Opensource Backer
Livecode Opensource Backer
 
Posts: 21
Joined: Thu Feb 03, 2011 8:51 pm

Re: Project: User Guide tech edit

Postby FourthWorld » Thu Jun 19, 2014 2:46 pm

In my last meeting with the team Ben said he would put the User Guide source files (currently in Word format) into the github repository. I'll drop a note here once those are posted.

Dan, thanks for offering to help. You have of course an unusually keen mind for this sort of thing, and I appreciate your jumping on board.
Richard Gaskin
Community volunteer LiveCode Community Liaison

LiveCode development, training, and consulting services: Fourth World Systems: http://FourthWorld.com
LiveCode User Group on Facebook : http://FaceBook.com/groups/LiveCodeUsers/
FourthWorld
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
 
Posts: 5305
Joined: Sat Apr 08, 2006 7:05 am
Location: Los Angeles

Re: Project: User Guide tech edit

Postby FourthWorld » Fri Jul 11, 2014 9:23 pm

Dan, and anyone else interested in helping this tech edit update of the User Guide:

I just got an email from Neil Roger at RunRev, who tells me we should see the User Guide source files (in Microsoft Word format) posted to GitHub soon, probably next week.

It's almost "Go!" time on this. Dan, I hope you still have time - your experience with such things would make your contribution invaluable.
Richard Gaskin
Community volunteer LiveCode Community Liaison

LiveCode development, training, and consulting services: Fourth World Systems: http://FourthWorld.com
LiveCode User Group on Facebook : http://FaceBook.com/groups/LiveCodeUsers/
FourthWorld
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
 
Posts: 5305
Joined: Sat Apr 08, 2006 7:05 am
Location: Los Angeles

Re: Project: User Guide tech edit

Postby capellan » Sat Jul 26, 2014 12:22 am

Hi Richard,

I visited https://github.com/runrev/livecode and could not
find this Word document.
Where could I download it?

Thanks in advance!

Al
capellan
 
Posts: 348
Joined: Wed Aug 15, 2007 11:09 pm

Re: Project: User Guide tech edit

Postby FourthWorld » Sat Jul 26, 2014 1:27 am

It may be up by Monday.

Will you be working on LibreOffice? While the original format is in Microsoft Word, they want to move to open formats and LibreOffice/OpenOffice seems the best fit for now.

Note that once the original is posted you'll still want to wait for Dan and I (and whomever else wants to help) clean up the content first to remove any outdated materials, so your translation efforts can be well applied to what will become the v7 User Guide.
Richard Gaskin
Community volunteer LiveCode Community Liaison

LiveCode development, training, and consulting services: Fourth World Systems: http://FourthWorld.com
LiveCode User Group on Facebook : http://FaceBook.com/groups/LiveCodeUsers/
FourthWorld
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
 
Posts: 5305
Joined: Sat Apr 08, 2006 7:05 am
Location: Los Angeles

Re: Project: User Guide tech edit

Postby capellan » Sat Jul 26, 2014 8:14 pm

Wonderful! :D
I will wait until the document have been updated.

Al
capellan
 
Posts: 348
Joined: Wed Aug 15, 2007 11:09 pm

Re: Project: User Guide tech edit

Postby capellan » Mon Sep 15, 2014 7:25 pm

FourthWorld wrote:It may be up by Monday.


Hi Richard,

Where could I find the Word document with the new LiveCode 7 Guide?
I searched in: https://github.com/runrev/livecode/tree/develop/docs/
but could not find it.

Alejandro
capellan
 
Posts: 348
Joined: Wed Aug 15, 2007 11:09 pm

Re: Project: User Guide tech edit

Postby FourthWorld » Tue Sep 16, 2014 1:42 am

I'll dig up the link and post it there. I should note, though, that it won't be a good version for your translation efforts, since we still need to do the tech edit on this English version to bring it current. Hopefully we can still meet our original goal of getting that done before v7 GM1 ships.
Richard Gaskin
Community volunteer LiveCode Community Liaison

LiveCode development, training, and consulting services: Fourth World Systems: http://FourthWorld.com
LiveCode User Group on Facebook : http://FaceBook.com/groups/LiveCodeUsers/
FourthWorld
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
 
Posts: 5305
Joined: Sat Apr 08, 2006 7:05 am
Location: Los Angeles

Re: Project: User Guide tech edit

Postby BvG » Mon Jan 05, 2015 2:11 pm

I can't find it, all I could find was in pdf form at:
https://github.com/runrev/livecode-ide/ ... tation/pdf
Use an alternative Dictionary viewer:
http://bjoernke.com/bvgdocu/

Chat with other RunRev developers:
chat.freenode.net:6666 #livecode
BvG
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
 
Posts: 1235
Joined: Sat Apr 08, 2006 1:10 pm
Location: Zurich

Re: Project: User Guide tech edit

Postby BvG » Sat Mar 14, 2015 11:01 am

No answer is also an answer I guess...
Use an alternative Dictionary viewer:
http://bjoernke.com/bvgdocu/

Chat with other RunRev developers:
chat.freenode.net:6666 #livecode
BvG
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
 
Posts: 1235
Joined: Sat Apr 08, 2006 1:10 pm
Location: Zurich

Re: Project: User Guide tech edit

Postby FourthWorld » Sat Mar 14, 2015 2:39 pm

BvG wrote:No answer is also an answer I guess...

It turns out that I don't actually read every post in these forums, so from time to time I may miss one.

Ben and I have had scheduling challenges so our meetings have been less regular in recent weeks than we'd prefer.

While I wait to hear back from Ben on this, I took a moment to go to the Github repository and after a click or two poking around I was able to find a "docs" branch there:
https://github.com/runrev/livecode/tree/8.0.0-pr-2/docs

I'm not certain if that's the optimal branch for working with at this stage. It may be that the "8.0.0-pr-2" branch is specific to that build. I'll have to wait for guidance from Ben to be sure.

But in the meantime at least you'll be able to explore the content there to become familiar with its scope and format.
Richard Gaskin
Community volunteer LiveCode Community Liaison

LiveCode development, training, and consulting services: Fourth World Systems: http://FourthWorld.com
LiveCode User Group on Facebook : http://FaceBook.com/groups/LiveCodeUsers/
FourthWorld
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
 
Posts: 5305
Joined: Sat Apr 08, 2006 7:05 am
Location: Los Angeles


Return to Learning Resources

Who is online

Users browsing this forum: No registered users and 0 guests