ADRIFT Manual
- Campbell
- Site Admin
- Posts: 4734
- Joined: Sun Jun 23, 2002 12:05 pm
- Points: 0
- Location: Edinburgh, Scotland
- Contact:
ADRIFT Manual
Due to overwhelming demand, I have started work on a "proper" manual for ADRIFT 5. There will be two versions - a context sensitive (i.e. it will be possible to go straight to the relevant section of the help directly from the application) offline version, and an online version.
You can see the online version in it's current state at http://help.adrift.co. Please remember that it is still under construction. However, I would welcome any feedback.
You can see the online version in it's current state at http://help.adrift.co. Please remember that it is still under construction. However, I would welcome any feedback.
ADRIFT Developer developer.
Re: ADRIFT Manual
I love the nice clear look of it, and the treeview index makes it very fast to navigate to the page you want.
Using the terms general function and expression function is good as I have never known what I should be calling the different types of function in ADRIFT.
But this has made me wonder about the term "object oriented function".
It is very long-winded, necessitating the abbreviation "OO" to try to shorten it.
It is also very much a programmers technical term that might sound daunting to non-technical people.
Perhaps a more ADRIFT-relevant name like "item function" or "property function" would be simpler.
Using the terms general function and expression function is good as I have never known what I should be calling the different types of function in ADRIFT.
But this has made me wonder about the term "object oriented function".
It is very long-winded, necessitating the abbreviation "OO" to try to shorten it.
It is also very much a programmers technical term that might sound daunting to non-technical people.
Perhaps a more ADRIFT-relevant name like "item function" or "property function" would be simpler.
- Lazzah
- Moderator
- Posts: 2442
- Joined: Thu Mar 31, 2011 5:54 am
- Points: 65
- Location: Clacton-on-Sea, Essex
Re: ADRIFT Manual
I very much like the new manual but I do think it would be a good idea to provide a "Glossary of Terms" to explain what some of the technical terms mean. The first time someone mentioned a "disambiguation prompt" to me I had no idea what they were talking about.saabie wrote:It is also very much a programmers technical term that might sound daunting to non-technical people.
The Axe of Kolt, The Spectre of Castle Coris, The Fortress of Fear, Die Feuerfaust, The Lost Children, Run, Bronwynn, Run, The Call of the Shaman, The Lost Labyrinth of Lazaitch, Magnetic Moon, Starship Quest, Revenge of the Space Pirates
- Campbell
- Site Admin
- Posts: 4734
- Joined: Sun Jun 23, 2002 12:05 pm
- Points: 0
- Location: Edinburgh, Scotland
- Contact:
Re: ADRIFT Manual
I added a glossary section - I just haven't added that definition yet.
ADRIFT Developer developer.
- Campbell
- Site Admin
- Posts: 4734
- Joined: Sun Jun 23, 2002 12:05 pm
- Points: 0
- Location: Edinburgh, Scotland
- Contact:
Re: ADRIFT Manual
Yes, I agree, I will rename them.saabie wrote:this has made me wonder about the term "object oriented function".
It is very long-winded, necessitating the abbreviation "OO" to try to shorten it.
It is also very much a programmers technical term that might sound daunting to non-technical people.
Perhaps a more ADRIFT-relevant name like "item function" or "property function" would be simpler.
ADRIFT Developer developer.
Re: ADRIFT Manual
It looks great Campbell. I don't know what else to say
This is what I've been longing for... that and a huge increase in my salary ... but one of two isn't that bad either.

This is what I've been longing for... that and a huge increase in my salary ... but one of two isn't that bad either.

D-Day in progress 86Kb (Slowly drifting)
October 31st: 60Kb (possible entry for IFComp 2021
)
October 31st: 60Kb (possible entry for IFComp 2021

Re: ADRIFT Manual
I too notice it leant towards the more technical side of writing with things like 'child', 'parent', 'node' and "To use the value of a property in an expression or a text box, use a location function." I'm guessing manual writing isn't your strong point Campbell...saabie wrote:I love the nice clear look of it, and the treeview index makes it very fast to navigate to the page you want.
Using the terms general function and expression function is good as I have never known what I should be calling the different types of function in ADRIFT.
But this has made me wonder about the term "object oriented function".
It is very long-winded, necessitating the abbreviation "OO" to try to shorten it.
It is also very much a programmers technical term that might sound daunting to non-technical people.
Perhaps a more ADRIFT-relevant name like "item function" or "property function" would be simpler.


Re: ADRIFT Manual
VERY nice!!
"Live well, Love much, Laugh often"
Working on: "Deperate Isle" and "Niki - An Adult Graphic Adventure"
reelyor@msn.com
Roy
Working on: "Deperate Isle" and "Niki - An Adult Graphic Adventure"
reelyor@msn.com
Roy
- Campbell
- Site Admin
- Posts: 4734
- Joined: Sun Jun 23, 2002 12:05 pm
- Points: 0
- Location: Edinburgh, Scotland
- Contact:
Re: ADRIFT Manual
Thanks for that. You do know I'm busting a gut here...NickyDude wrote:I'm guessing manual writing isn't your strong point Campbell...
The manual is based off the Wiki which has been round for some time. The reason I went for a wiki in the first place was so it could be a joint effort. If you don't like the way something is written or explained, please, re-write it to something more suitable!

ADRIFT Developer developer.
- Lazzah
- Moderator
- Posts: 2442
- Joined: Thu Mar 31, 2011 5:54 am
- Points: 65
- Location: Clacton-on-Sea, Essex
Re: ADRIFT Manual
Maybe you could move the glossary to the beginning of the manual where it is more noticeable? At the moment it is buried way down near the bottom of the tree. The reader might need to know what these terms are before they start looking for whatever section of the manual the wish to read. I would also give an example of a disambiguation prompt just to make sure they are fully aware of what you mean in you explanation of the term.Campbell wrote:I added a glossary section - I just haven't added that definition yet.
The Axe of Kolt, The Spectre of Castle Coris, The Fortress of Fear, Die Feuerfaust, The Lost Children, Run, Bronwynn, Run, The Call of the Shaman, The Lost Labyrinth of Lazaitch, Magnetic Moon, Starship Quest, Revenge of the Space Pirates
- Campbell
- Site Admin
- Posts: 4734
- Joined: Sun Jun 23, 2002 12:05 pm
- Points: 0
- Location: Edinburgh, Scotland
- Contact:
Re: ADRIFT Manual
If you look on Wikipedia, "Traditionally, a glossary appears at the end of a book and includes terms within that book that are either newly introduced, uncommon, or specialized.". I think this is the most sensible place for it. It's not difficult to find, and I daresay not everyone will need it.
ADRIFT Developer developer.
- Lazzah
- Moderator
- Posts: 2442
- Joined: Thu Mar 31, 2011 5:54 am
- Points: 65
- Location: Clacton-on-Sea, Essex
Re: ADRIFT Manual
Point taken.Campbell wrote:If you look on Wikipedia, "Traditionally, a glossary appears at the end of a book and includes terms within that book that are either newly introduced, uncommon, or specialized.". I think this is the most sensible place for it. It's not difficult to find, and I daresay not everyone will need it.

The Axe of Kolt, The Spectre of Castle Coris, The Fortress of Fear, Die Feuerfaust, The Lost Children, Run, Bronwynn, Run, The Call of the Shaman, The Lost Labyrinth of Lazaitch, Magnetic Moon, Starship Quest, Revenge of the Space Pirates
Re: ADRIFT Manual
just want to say you're doing an awesome job on the manual! 

