Recent

Author Topic: New User Portal for the Wiki  (Read 6704 times)

trev

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1214
  • Former Delphi 1-7, 10.2 User
New User Portal for the Wiki
« on: March 09, 2020, 01:24:15 pm »
I had a stab at the New User Portal which was suggested in the "Tutorial Web/Wiki" thread which I didn't wish to hijack.

It's a Wiki, so feel free to add to/update/fix the content on the page. I ran out of ideas pretty fast...
o Lazarus 2.1 r64368 FPC 3.3.1 r48100 macOS 10.14.6 Xcode 11.3.1
o Lazarus 2.1 r64392 3.3.1 Jan 13 21:24 macOS 11.1 aarch64 Xcode 12.3
o Lazarus 2.1 r61574 3.3.1 r42318 FreeBSD 12.1 amd64 VMware VM
o Lazarus 2.1 r61574 3.0.4 Ubuntu 20.04 Parallels VM
o Lazarus 2.0.10 3.2.0 Win10 Parallels VM

minesadorada

  • Hero Member
  • *****
  • Posts: 608
  • Retired
Re: New User Portal for the Wiki
« Reply #1 on: March 09, 2020, 01:30:20 pm »
What is the difference between a Portal page and a Category page?
GPL Apps: Health MonitorRetro Ski Run
OnlinePackageManager Components: LazAutoUpdate, LongTimer, PoweredBy, ScrollText, PlaySound, CryptINI

trev

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1214
  • Former Delphi 1-7, 10.2 User
Re: New User Portal for the Wiki
« Reply #2 on: March 10, 2020, 12:29:33 am »
A Portal page is a human curated page that has had some thought, understanding and organisation applied to its creation and maintenance.

A Category page is a computer generated page which extracts all pages which have been tagged as belonging to the category from the database.

To see the difference with an example, take the Mac Portal page and then compare it to the macOS Category page.
o Lazarus 2.1 r64368 FPC 3.3.1 r48100 macOS 10.14.6 Xcode 11.3.1
o Lazarus 2.1 r64392 3.3.1 Jan 13 21:24 macOS 11.1 aarch64 Xcode 12.3
o Lazarus 2.1 r61574 3.3.1 r42318 FreeBSD 12.1 amd64 VMware VM
o Lazarus 2.1 r61574 3.0.4 Ubuntu 20.04 Parallels VM
o Lazarus 2.0.10 3.2.0 Win10 Parallels VM

AL

  • Full Member
  • ***
  • Posts: 211
Re: New User Portal for the Wiki
« Reply #3 on: March 10, 2020, 01:36:51 am »
Excellent work Trev.  But how can I find this portal from the main page?
Laz 2.1.0, fpc 3.3.1, Win10
Laz 2.1.0, fpc 3.3.1, Mac OS Mojave running on VMWare
Laz 2.1.0  fpc 3.3.1 Ubuntu 20.04

trev

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1214
  • Former Delphi 1-7, 10.2 User
Re: New User Portal for the Wiki
« Reply #4 on: March 10, 2020, 04:15:27 am »
In the near future, a main page which is very similar to this mockup will become the Wiki main page. You can bookmark that page for the time being.
o Lazarus 2.1 r64368 FPC 3.3.1 r48100 macOS 10.14.6 Xcode 11.3.1
o Lazarus 2.1 r64392 3.3.1 Jan 13 21:24 macOS 11.1 aarch64 Xcode 12.3
o Lazarus 2.1 r61574 3.3.1 r42318 FreeBSD 12.1 amd64 VMware VM
o Lazarus 2.1 r61574 3.0.4 Ubuntu 20.04 Parallels VM
o Lazarus 2.0.10 3.2.0 Win10 Parallels VM

zoltanleo

  • Sr. Member
  • ****
  • Posts: 289
Re: New User Portal for the Wiki
« Reply #5 on: March 10, 2020, 07:15:36 am »
A Portal page is a human curated page that has had some thought, understanding and organisation applied to its creation and maintenance.
Great job, Trev. I liked the new edition.  ;)
Win10 LTSC x64/Deb 10 amd64/Darwin Cocoa:
Lazarus x32/x64 2.1(r.64226); FPC 3.3.1 (r.47808), FireBird 3.0.7

Sorry for my bad English, I'm using translator ;)

Otto

  • Full Member
  • ***
  • Posts: 226
Re: New User Portal for the Wiki
« Reply #6 on: March 10, 2020, 12:02:49 pm »
Good job trev.

If possible, I would like to translate your page into the Italian language. However, I do not have much experience with the mediawiki in duplicating the structure of the page, I made a try, but did not satisfy me.

Is there essential documentation for duplication and deletion of mediawiki pages?
Kind regards.

trev

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1214
  • Former Delphi 1-7, 10.2 User
Re: New User Portal for the Wiki
« Reply #7 on: March 10, 2020, 12:40:58 pm »
Otto, I fixed up one of your earlier drafts after a few mis-steps of my own. It should be ready for you to translate the two templates now. Just click the "edit" annotations on the two boxes.

(I learn by trial and error :) )
o Lazarus 2.1 r64368 FPC 3.3.1 r48100 macOS 10.14.6 Xcode 11.3.1
o Lazarus 2.1 r64392 3.3.1 Jan 13 21:24 macOS 11.1 aarch64 Xcode 12.3
o Lazarus 2.1 r61574 3.3.1 r42318 FreeBSD 12.1 amd64 VMware VM
o Lazarus 2.1 r61574 3.0.4 Ubuntu 20.04 Parallels VM
o Lazarus 2.0.10 3.2.0 Win10 Parallels VM

Otto

  • Full Member
  • ***
  • Posts: 226
Re: New User Portal for the Wiki
« Reply #8 on: March 10, 2020, 02:55:00 pm »
Thank you trev.

I will finish the translation.

If there wasn't already, as soon as possible, we could create a new portal with topic:
essential documentation of the mediawiki.

Where to share the basic and advanced techniques for writing documentation for Lazarus and FPC.
Kind regards.

trev

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1214
  • Former Delphi 1-7, 10.2 User
Re: New User Portal for the Wiki
« Reply #9 on: March 10, 2020, 11:57:01 pm »
A comprehensive resource exists for MediaWiki Wikis. See the mother of all Help Wikis.
o Lazarus 2.1 r64368 FPC 3.3.1 r48100 macOS 10.14.6 Xcode 11.3.1
o Lazarus 2.1 r64392 3.3.1 Jan 13 21:24 macOS 11.1 aarch64 Xcode 12.3
o Lazarus 2.1 r61574 3.3.1 r42318 FreeBSD 12.1 amd64 VMware VM
o Lazarus 2.1 r61574 3.0.4 Ubuntu 20.04 Parallels VM
o Lazarus 2.0.10 3.2.0 Win10 Parallels VM

Otto

  • Full Member
  • ***
  • Posts: 226
Re: New User Portal for the Wiki
« Reply #10 on: March 11, 2020, 11:16:43 am »
Thank you trev.

I will study the official documentation.

Otto.
Kind regards.

dbannon

  • Hero Member
  • *****
  • Posts: 1268
    • tomboy-ng, a rewrite of the classic Tomboy
Re: New User Portal for the Wiki
« Reply #11 on: March 11, 2020, 12:51:29 pm »
Nice work Trev, nice work !

Some thoughts,

1. Your first block of text, which now defines the page and provides instructions to people like us wanting to contribute to it, really should be more of a welcome page, more directed to the new user. Its probably the first thing they read, research indicates we have about 15 seconds to get and keep their attention. 

2. Just under that block is a Related Topics section.  Is that there because its a defined in a "Portal Template" or can we move it further down ?   Again, its not what a new user is looking for.

3. The next section, "Start Here" on the left, "Resources" on the right, thats great, just the layout we need.  I think the we need to cherry pick existing Tutorials (and freshen them up) or write some new ones.  The Forms Tutorial sounded good initially but quickly got into advanced topics.  New users like to see short tutorials they think they can complete in five minutes or so. Latter on, when hooked, let them seek out the advanced ones.

I think the model is great, a landing zone for new users that gets them past the initial barrier is so needed.  I am sure I have my old Delphi 2 books around somewhere, without in any way copying, we could look to that for the scale of the first, say, three tutorials ?

Davo
Lazarus 2, Linux (and reluctantly Win10, OSX)
My Project - https://github.com/tomboy-notes/tomboy-ng

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 9022
  • FPC developer.
Re: New User Portal for the Wiki
« Reply #12 on: March 11, 2020, 12:52:09 pm »
Thank you trev.

I will finish the translation.

If there wasn't already, as soon as possible, we could create a new portal with topic:
essential documentation of the mediawiki.

Where to share the basic and advanced techniques for writing documentation for Lazarus and FPC.

There already is a subforum on this forum for discussions about documentation techniques.

(added later:
Haha, while I was writing it, some other moderator already move the post here :-)

Otto

  • Full Member
  • ***
  • Posts: 226
Re: New User Portal for the Wiki
« Reply #13 on: March 11, 2020, 06:14:30 pm »
Thank you marcov.
Kind regards.

trev

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1214
  • Former Delphi 1-7, 10.2 User
Re: New User Portal for the Wiki
« Reply #14 on: March 12, 2020, 01:24:57 am »
1. Your first block of text, which now defines the page and provides instructions to people like us wanting to contribute to it, really should be more of a welcome page, more directed to the new user. Its probably the first thing they read, research indicates we have about 15 seconds to get and keep their attention. 

This is the portal page template. See below...

Quote
2. Just under that block is a Related Topics section.  Is that there because its a defined in a "Portal Template" or can we move it further down ?   Again, its not what a new user is looking for.

Before retiring a few years ago, I spent years working in commercial legal publishing (20 years) and then not-for-profit legal publishing (13 years) as editor, writer, editorial publishing system creator (for a VAX with VMS, then for a Sun with Solaris), Delphi programmer, customer support, business unit IT consultant and finally as user support manager and systems programmer. In the commercial case, almost all the customers were lawyers and accountants. In the not-for-profit case, many of the users were self-represented litigants. In all cases, consistency of presentation was important to both the consumers of the content and the creators and maintainers of the content.

I do understand your point, but I'm not so sure that changing the layout of this one portal page any more than I already have (by omitting the image gallery) would be a sensible thing to do. I may be wrong. It happens. My opinion is no more valid than yours. If you or someone else comes along and redesigns the page, I won't complain and I certainly won't revert the edits. It's not my page. It's a Wiki. Anyone and everyone can edit it. I'll be happy if my only contribution is that it exists to help new users.

Quote
3. The next section, "Start Here" on the left, "Resources" on the right, thats great, just the layout we need.  I think the we need to cherry pick existing Tutorials (and freshen them up) or write some new ones.  The Forms Tutorial sounded good initially but quickly got into advanced topics.  New users like to see short tutorials they think they can complete in five minutes or so. Latter on, when hooked, let them seek out the advanced ones.

I agree completely. I was working with what currently exists. It is always easier to start with something than to start from scratch. It is not perfect, but the longest journey begins with the first step. I consider what I've done so far as the first step. As for writing new tutorials and/or freshening up existing ones, the harvest is plentiful but the labourers are few.

Quote
I think the model is great, a landing zone for new users that gets them past the initial barrier is so needed.  I am sure I have my old Delphi 2 books around somewhere, without in any way copying, we could look to that for the scale of the first, say, three tutorials ?

This sounds good for the next step.
o Lazarus 2.1 r64368 FPC 3.3.1 r48100 macOS 10.14.6 Xcode 11.3.1
o Lazarus 2.1 r64392 3.3.1 Jan 13 21:24 macOS 11.1 aarch64 Xcode 12.3
o Lazarus 2.1 r61574 3.3.1 r42318 FreeBSD 12.1 amd64 VMware VM
o Lazarus 2.1 r61574 3.0.4 Ubuntu 20.04 Parallels VM
o Lazarus 2.0.10 3.2.0 Win10 Parallels VM

 

TinyPortal © 2005-2018