Re: [Phpwebsite-developers] 1.x Documentation

[Matthew M. <ma...@tu...>]

Ok Greg. I have had a night's sleep and have had coffee.

My mind is clear and I understand.

This is what I propose:

A core class for help

The config file for help contains the main wiki address

The help class will create either a link to the wiki or push the user
there automatically.

The help class will add the localization prefix to the file name.

We will go with en_filename (fr_filename, de_filename, etc.)

This work for everyone?

Thanks Greg,
Matt


On Wed, 2005-11-02 at 01:13 -0700, Greg Morgan wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> Matt,
> 
> Background:
> As you asked I have posted a message here to continue the discussion
> that we had today on IRC
> http://www.phpwebsitemanual.com/index.php?module=pagemaster&PAGE_user_op=view_page&PAGE_id=103&date=20051101
> . As you point out " drkludge, that would be cool. however, there isn't
> a wiki for 1.x yet :)"  However, the idea will give you the 1.x pages to
> link to.
> 
> Fallout Seems Close:
> I figured out that 1.x was really close when I created the fallout doc
> page http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=Fallout
> .  So I sense the need to switch over to work on 1.x release.  I
> submitted an RFE for the secure_phpws.sh script here
> https://sourceforge.net/tracker/index.php?func=detail&aid=1345623&group_id=15539&atid=315539
> .  It still needs work but gets the job done for starters.  The run
> option may be flaky just 'cause I don't think I know all the files to
> secure yet.  Matt will be happy to receive additional patches to the script.
> 
> The live linking to wiki page idea verses .txt files:
> So how 'bout doc?  Well I was thinking I want to leave the 0.10.x wiki
> documentation alone.  What I have been doing is creating content and
> then point FAQ questions from the forums to the doc.  You can see the
> samples here
> http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=User_FAQ .
> I see that Matt has localization in the setup help files.  This gave me
> and idea for how 1.x and 0.10.x can co-exist.  In the setup directory
> are help files
> pwd
> /var/www/fallout2/setup/help
> [root@bagheera help]# ls
> database.en.txt  permissions.en.txt  sessions.en.txt
> I have taken a bunch of these .txt files to seed the current wiki pages.
>  The problem with this is that the users only read the .txt and run into
> the same problem over and over again in the forums.  The .txt presume
> that they have some prior knowledge that many do not have.  So for this
> release I'd rather have the .txt files put in the wiki and accessible to
> the community to edit.  The proposal then provides a mechanism to do
> this and it will make the existing doc co-exist with the fallout doc.
> 
> So for example there is a database page in the wiki that is 0.10.x
> oriented.  With a little work it can be 1.x oriented.  If Matt where to
> create a constant to the wiki URL of
> "http://phpwebsite-comm.sourceforge.net/wiki/index.php?title="  then
> we're part way there.  So now if I copy the
> http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=database
> page to
> http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=en_database
> then the fallout adjustments can be made.  The existing database page
> will work for the current 0.10.x users.  The new en_database page would
> be localized.  Other languages would use the same page name but use
> fr_database as their page name.  In the 1.x documentation, I would use
> the [[en_database | database]] convention each time I wanted to wiki
> link to the page.  I use this technique now when I want to refer to
> [[web hosting company]]  as a plural i.e. [[web hosting company | web
> hosting companies]].
> 
> The wiki allows forum posts to be massaged together into something
> meaningful.  The phpwebsite community can help create the documentation
> so that the core developer's don't have to do it all.  All we need is
> for the code to point to the wiki pages verses text files.  I recommend
> the en_ prefix because then each localization will be grouped together
> on the all pages page
> http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=Special:Allpages
> I think the that this will help the users find the documentation.  What
> they do now is install via text file; fail; forum post; then if I answer
> the post, I point 'em to the wiki page.  Some samples
> https://sourceforge.net/forum/message.php?msg_id=3400102 and
> https://sourceforge.net/forum/message.php?msg_id=3398961 .  See with the
> new 1.x links they can point the the wiki page right away and start
> looking for the answer.  Moreover, as I said in the Attribution on the
> FAQ page "Dr kludge would also like to thank firefox. It was through the
> Mozzilazine Knowledge Base (http://kb.mozillazine.org/Main_Page) that
> he was inspired to write  FAQ questions that point back to specific
> areas of the wiki documentation. This technique saves having multiple
> places and sources of the same information and battle tests the
> documentation. The  FAQ questions point to weaknesses in the main wiki
> documentation that need to be enhanced for there to be an effective
> answer to the question."
> 
> Regards,
> Greg
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.1 (GNU/Linux)
> Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org
> 
> iD8DBQFDaHUXxyxe5L6mr7IRAnA9AKCmbxc76eexlAJwBU0hCF5o3k7x6QCfXj3E
> KshzwLgBXkjG3pOpteE0aAw=
> =Noiz
> -----END PGP SIGNATURE-----
> 
> 
> -------------------------------------------------------
> SF.Net email is sponsored by:
> Tame your development challenges with Apache's Geronimo App Server. Download
> it for free - -and be entered to win a 42" plasma tv or your very own
> Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
> _______________________________________________
> Phpwebsite-developers mailing list
> Php...@li...
> https://lists.sourceforge.net/lists/listinfo/phpwebsite-developers
-- 
Matthew McNaney
Electronic Student Services
Appalachian State University
http://phpwebsite.appstate.edu