Not logged in. · Lost password · Register
Forum: Community Documentation RSS
Volunteers?
Looking for volunteers to work on docs

Announcement

11-16-2005, 12:33 by halr9000
Subject: Psi Groupchat (new address)
Join us at the Psi Groupchat (MUC)! Room name: psi@conference.psi-im.org
Page:  previous  1  2 
Avatar
Kev (Administrator) #16
User title: Project Lead
Member since 11/2002 · 2998 posts · Location: Exeter, UK
Group memberships: Administrators, Developers, Members
Show profile · Link to this post
PDF and WYSIWYG are both anagrams.
Both are, however, standard. PDF's been the common name since implementation, and WYSIWYG's been a standard term for about 20 years.
Psi Project Leader.
Homepage, including development blog
Avatar
michalj (Moderator) #17
Member since 04/2004 · 2174 posts · Location: Legionowo, Poland
Group memberships: Global Moderators, Members
Show profile · Link to this post
Quote by Kev on 09-07-2004, 12:48:
PDF and WYSIWYG are both anagrams.
Both are, however, standard. PDF's been the common name since implementation, and WYSIWYG's been a standard term for about 20 years.
Hmmm.
Anagram = word formed from the rearranged letters of another.
Acronym = word formed from the initial letters of others.

I thought that PDF and WYSIWYG are acronyms and not anagrams. :P

PDF = Portable Document Format
WYSIWYG = What You See Is What You (might) Get
Michał Jazłowiecki (michalj)
Psi Forum & Wiki Moderator :: Psi-Daisy Author
Avatar
Kev (Administrator) #18
User title: Project Lead
Member since 11/2002 · 2998 posts · Location: Exeter, UK
Group memberships: Administrators, Developers, Members
Show profile · Link to this post
Impressive I managed to reply without actually reading the post.
Yes, Acronyms they are, Anagrams they're not.
*stoopid*
*stoopid*
*stoopid*
*stoopid*
Psi Project Leader.
Homepage, including development blog
jhardee #19
Member since 07/2006 · 7 posts
Group memberships: Members
Show profile · Link to this post
I would be willing to work on Psi documentation.  I'm in the process of learning Psi and don't have much experience with IM clients so my perspective should be useful.  Also, I've recently finished some technical writing courses.  Let me know what's needed and I'll see what I can do.

-Jeff
Avatar
Kev (Administrator) #20
User title: Project Lead
Member since 11/2002 · 2998 posts · Location: Exeter, UK
Group memberships: Administrators, Developers, Members
Show profile · Link to this post
We should discuss this with Hal but, to my mind, what we need is a good, self-contained, beginner's guide that one can look at which explains how to choose a server, how to register with the server / add the account to Psi, how to chat with your friends on msn, as these are the things that most people are probably interested in.

Of course, if you're interested in doing more, there's documentation for just about every feature in Psi missing ;)

Whatever you're wiling to help with, there's a body of work in the wiki which, although somewhat overgrown, is probably relevant. I'll wait for Hal to chip in on the discussion now :)
Psi Project Leader.
Homepage, including development blog
IceRAM (Moderator) #21
Member since 05/2003 · 1286 posts · Location: Bucharest, Romania
Group memberships: Global Moderators, Members
Show profile · Link to this post
I've been trying to do this for a really long time but there's one big show-stopper (I think this is how it's called) - NO NEW GRAPHICS* (which we've been waiting for a long time). I personally find it pretty hard to document something without putting some screenshots in.

A bit off-topic: is there any news on the new graphics?

*) graphics = iconsets (for the screenshots) + others (website etc.)
::/ my .net presence / weblog | psi
This post was edited 2 times, last on 08-10-2006, 10:34 by IceRAM.
Avatar
halr9000 (Administrator) #22
User title: I work here
Member since 11/2002 · 2253 posts · Location: Atlanta
Group memberships: Administrators, Members
Show profile · Link to this post
Ooh ooh, fresh meat!  Yeah, we'd love the help.  As Kev said, anything on the Wiki is fair game, but what we need most is a beginner user's guide.  There are some conflicting terms on the wiki right now IMO, we have the User's Guide, Tutorial, and Installation Guide.  If I were you, I'd start by unifying or clarifying what these separate documents would be for, and then have at it.  Feel free to contact me directly for any questions or advice about girls or whatever.
Hal Rottenberg
Webmaster, Evangelist, Co-conspirator to the Revolution
IceRAM (Moderator) #23
Member since 05/2003 · 1286 posts · Location: Bucharest, Romania
Group memberships: Global Moderators, Members
Show profile · Link to this post
User's Guide = Comprehensive information on all topics/terms involving Jabber with Psi

Tutorial = One medium size page containing everything to get somebody started with Psi as an IM client
  • contains relevant information from the User's Guide
  • linked only if necessary with the User's Guide, since we don't want to confuse users

Installation Guide = different document, since it is platform specific


Currently, they are in this state, but they're a bit outdated. The tutorial, which I think it's a priority, can't be easily updated (IMO) without new graphics/a decision on the new graphics.

IMO, these documents should be separated since they are meant for different things. Also, as I've suggested a long time ago, they should be linked (only these 3) in the announcement of a new version.
::/ my .net presence / weblog | psi
Avatar
halr9000 (Administrator) #24
User title: I work here
Member since 11/2002 · 2253 posts · Location: Atlanta
Group memberships: Administrators, Members
Show profile · Link to this post
Yes, giving links to the install guide at the very least is a good idea.
Hal Rottenberg
Webmaster, Evangelist, Co-conspirator to the Revolution
Avatar
anakowi #25
Member since 06/2006 · 15 posts · Location: Australia
Group memberships: Members
Show profile · Link to this post
Do you still need the screen shots (cleaned up, refined, web-optimised)  for the wiki tutorial - or is that already underway for Mac and Win?
b e a d g - 5 strings will be plenty
Avatar
Kev (Administrator) #26
User title: Project Lead
Member since 11/2002 · 2998 posts · Location: Exeter, UK
Group memberships: Administrators, Developers, Members
Show profile · Link to this post
I don't think there's a problem with generating screenshots (I can make them for all our platforms if need be), the problem was that the old iconsets were due to be replaced and it didn't make sense making screenshots when they were due to change.
Psi Project Leader.
Homepage, including development blog
Avatar
anakowi #27
Member since 06/2006 · 15 posts · Location: Australia
Group memberships: Members
Show profile · Link to this post
Subject: wiki updates
I've been looking through the Wiki and Forum seeking some practical information to assist me "the average Psi end-user". This is not a criticism but once again an offer to help that I hope will kill-2-birds-with-one-stone: make a contribution and learn more about Psi/jabber features.

So I took the liberty of editing "profile management" wiki content but I still need to piece together what I can learn from "psi" developers/technical gurus. ( Actually I was trying to work out why I can't publish an image on vCard - but I got totally side-tracked :S ).

To begin with, three areas that I would like to address are:
1. Profile Management
2. Account identities
3. Personal Information - the vCard

My proposed outlines:

1. Profile Management
- What is a profile (simple end-user description with in-page-link to further technical description)
- How is the profile used (purpose, difference to having multiple userIDs)
- Who should use/add new profiles (include examples, pros/cons)
- Creating a profile (unedited so far, but I would simplify into practical steps, rationale to be covered in preceeding subheads)

2. Account Identities
- What is a Jabber Account
- About multiple Account identities (purpose, pros/cons)
- Practical tips when using multiple identies under a Psi Profile
- Creating Account identities
- Enabling and manageing Account identities

3. Personal Information - the vCard
- What is a vCard
- How is the vCard used (purpose, pros/cons)
- Technical requirements (does the Jabber server offer the facility?)
- Creating a vCard (simplify into practical steps, glossary of terms)
- Modifying your vCard (adding/changing images)

SO... shall I keep going?
I'm very reluctant to edit existing material (although I think it needs editing) because obviously that would be presumptious. Is it OK to streamline the wiki content as there's a bit of doubling up of info without cross-reference links? For instance "account management" under "User Guide" and "create an account" under "Tutorial".
I'll assume that the intention of the tutorial is a 'quick' guide for reasonably 'common-sense' computer users to get Psi connected - and that links to a more in-depth User Guide (novice to expert) are still to be added to the tutorial.
b e a d g - 5 strings will be plenty
Avatar
michalj (Moderator) #28
Member since 04/2004 · 2174 posts · Location: Legionowo, Poland
Group memberships: Global Moderators, Members
Show profile · Link to this post
Please do keep your work - I'm reading all Psi Wiki changes and I'll let you know if anything is not OK.

Notes:
1. Please try to keep some of the strings the same as they are in other parts of Psi Wiki, e.g. "Windows XP" (with space between "Windows" and "XP"), "Mac OS X" or "MacOS X" (with at least one space). Please also keep in mind that "user ID" in Jabber/XMPP is called "Jabber ID" or "JID" and this name should be used everywhere. Proprietary IM network's user IDs are also translated to Jabber IDs.
2. Try using Wiki features - like # tag for enumerations.
3. Three windows (tips, roster, add account) appear on all platforms (if there is no Psi profile), not just Mac OS X like you wrote. It would be worthy not to distinguish platforms where no such difference exists.

--- EDIT ---

Fixed formatting of a post - I've used SGML/XML-like tags (<>) instead of UNB ([]).
Michał Jazłowiecki (michalj)
Psi Forum & Wiki Moderator :: Psi-Daisy Author
This post was edited on 12-29-2006, 17:06 by michalj.
Avatar
anakowi #29
Member since 06/2006 · 15 posts · Location: Australia
Group memberships: Members
Show profile · Link to this post
thankyou.
from your notes:
1. I have corrected all mention of Windows XP, MacOS X, and replaced userID to Jabber ID
2. You have fixed already :)  but I didn't understand <m> </m> your mention of these tags. Anyway I looked at formatting info in wikiMedia, so I understand now. Did I make a typo "rooster"?
3. Apology. I didn't test again on XP - my bad memory.
b e a d g - 5 strings will be plenty
Avatar
michalj (Moderator) #30
Member since 04/2004 · 2174 posts · Location: Legionowo, Poland
Group memberships: Global Moderators, Members
Show profile · Link to this post
Quote by anakowi:
but I didn't understand <m> </m> your mention of these tags.
I was supposed to use [] [] tags (to display preformatted text), but I've mistaken the tag delimiters. Sorry.

Quote by anakowi:
Did I make a typo "rooster"?
No, you didn't. But many people say "rooster" (which means male hen or chicken) for contact list in Jabber/XMPP instead of "roster" (which means list of attendants, esp. in the army).

Quote by anakowi:
3. Apology. I didn't test again on XP - my bad memory.
No problem.
Michał Jazłowiecki (michalj)
Psi Forum & Wiki Moderator :: Psi-Daisy Author
Close Smaller – Larger + Reply to this post:
Smilies: :mellow: :huh: ^_^ :o ;) :P :D :lol: B) :rolleyes: -_- <_< :) :wub: :angry: :( :unsure: :wacko: :blink: :ph34r:
Special characters:
Page:  previous  1  2 
Go to forum
Unclassified NewsBoard devel of 20051113 © 2003-5 by Yves Goergen
Current time: 05-17-2008, 10:05:35 (UTC -04:00)