Author Topic: [Proposal:html documentation template] Same as for 'Get Started - Premiers pas]  (Read 2989 times)

Offline melodie

  • Hero Member
  • *****
  • Posts: 5942
  • XMMP=Jabber, free instant messaging protocol !
    • PCLinuxOS Fr
Hi,

I thought if some would want to have an allready tested type of html file... The one that allowed me to do this one:
http://meets.free.fr/files/Premiers_pas/usr/share/doc/HTML/fr/firststeps-fr.html

As I find Amaya did a good job for me, but is hard to run really (sort of blocks, full with annoying bugs... ) I would do a small template that can be used with a text editor and be completed that way.

I uploaded it with the .txt extension here : template-docs.html.txt. Please remove the .txt after downloading, in order to stay just with the ".html" extension (obvious, but never know... )

« Last Edit: January 30, 2010, 12:47:36 PM by melodie »
melodie at swissjabber dot ch - IRC #pclinuxos-fr sur freenode

Offline melodie

  • Hero Member
  • *****
  • Posts: 5942
  • XMMP=Jabber, free instant messaging protocol !
    • PCLinuxOS Fr
Hi,

I update the file today, added one tag for the images, and a short comment at the beginning to try to help thoses who don't know too much how to deal with CSS and html.

melodie at swissjabber dot ch - IRC #pclinuxos-fr sur freenode

Offline gseaman

  • PCLinuxOS Tester
  • Hero Member
  • *******
  • Posts: 3786
Thanks for sharing. This is a nice looking page.

Galen

Offline melodie

  • Hero Member
  • *****
  • Posts: 5942
  • XMMP=Jabber, free instant messaging protocol !
    • PCLinuxOS Fr
Hi,

I just updated it, with a few new lines in the comments. I added a translation of the explanations in french, and added some additional source informations in it. (links to Amaya and W3C  websites).

I corrected one or two words miswritten as well.

melodie at swissjabber dot ch - IRC #pclinuxos-fr sur freenode

Offline travisN000

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1758
Is this meant to be included with iso releases, or meant for online documentation?  Although I don't read / speak french, it looks like it might make a nice addition to the effor to localize / translate the wiki..

http://www.pclinuxos.com/wiki/index.php/PCLinuxOS_Administration_Center_(Fran%C3%A7ais)

(I created a copy of the english page as a starting point for any persons interested in creating french translaton...  If there are wiki related questions, or other wiki localization interests, let me know!)

Offline melodie

  • Hero Member
  • *****
  • Posts: 5942
  • XMMP=Jabber, free instant messaging protocol !
    • PCLinuxOS Fr
Is this meant to be included with iso releases, or meant for online documentation?


Hi,

For both. I included several in the isos I published, and put the same online.


About:
http://melodie.tyruiop.org/A-propos.html

Before install:
http://melodie.tyruiop.org/Documentation/aide-integree/Avant-installation.html

Howto install:
http://melodie.tyruiop.org/Documentation/aide-integree/aide_installation/fr/aide_installation.html

First steps (after install)
http://melodie.tyruiop.org/Documentation/aide-integree/premiers-pas/fr/firststeps-fr.html

(all documentation I use to include here: http://melodie.tyruiop.org/Documentation/)

Quote
Although I don't read / speak french, it looks like it might make a nice addition to the effor to localize / translate the wiki...


You will at least be able to read in the template document if you open it : I put a loooong comment at the beginning to explain how to use it : in french and in english.

Quote
http://www.pclinuxos.com/wiki/index.php/PCLinuxOS_Administration_Center_(Fran%C3%A7ais)

(I created a copy of the english page as a starting point for any persons interested in creating french translaton...  If there are wiki related questions, or other wiki localization interests, let me know!)


That's a good idea, although I don't quite see how the templace for docs can be useful there ?

melodie at swissjabber dot ch - IRC #pclinuxos-fr sur freenode

Offline travisN000

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1758
Quote
http://www.pclinuxos.com/wiki/index.php/PCLinuxOS_Administration_Center_(Fran%C3%A7ais)

(I created a copy of the english page as a starting point for any persons interested in creating french translaton...  If there are wiki related questions, or other wiki localization interests, let me know!)


That's a good idea, although I don't quite see how the templace for docs can be useful there ?





..I was suggesting that you consider adding your documentation (text/pics, etc) to the official wiki, not the template itself.

Offline melodie

  • Hero Member
  • *****
  • Posts: 5942
  • XMMP=Jabber, free instant messaging protocol !
    • PCLinuxOS Fr
..I was suggesting that you consider adding your documentation (text/pics, etc) to the official wiki, not the template itself.

Oh I see ! How do you insert images in there ? Don't they have to be uploaded somewhere ?

melodie at swissjabber dot ch - IRC #pclinuxos-fr sur freenode

Offline travisN000

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1758
When you create an account and log in you will have a link at the bottom of the left sided menu that will allow you to upload the images.  Once the file is uploaded and named you can insert it into your wiki page with standard wiki code:

Code: [Select]
[[File:Admincenter hardware manage 3.png]]
The upload page has addition info on the wiki code, but there are also ways ways to display larger collections of images..  For examples look at the following pages and their wiki code:

http://www.pclinuxos.com/wiki/index.php/Remote_Desktop_-_KDE
http://www.pclinuxos.com/wiki/index.php/Blue_Caress


If you have difficulty with wiki user account creation, contact Linuxera, as she has administrative authority over the wiki.


[attachment deleted by admin]
« Last Edit: November 05, 2009, 12:35:57 PM by travisn000 »

Offline melodie

  • Hero Member
  • *****
  • Posts: 5942
  • XMMP=Jabber, free instant messaging protocol !
    • PCLinuxOS Fr
Hi travisn000,

Thanks for your help and explanations. The first one is on the wiki, thanks to the good job done by nakux, new friend : Re: Participants bienvenus sur la section Wiki fr !.

The tutorial is here:
http://www.pclinuxos.com/wiki/index.php/Category:Installer_PCLinuxOS

Regards,
Mélodie

melodie at swissjabber dot ch - IRC #pclinuxos-fr sur freenode

Offline travisN000

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1758
..Its looking good!  ;D

PS  ..is that the 2010 PCLinuxOS  wallpaper on those screen-shots ???

Offline melodie

  • Hero Member
  • *****
  • Posts: 5942
  • XMMP=Jabber, free instant messaging protocol !
    • PCLinuxOS Fr
..Its looking good!  ;D

PS  ..is that the 2010 PCLinuxOS  wallpaper on those screen-shots ???

Not at all, it's the KDE 3.5 french remaster. I am looking forward to redo the screenshots after next release will be out, to make them look a bit more official !  ;D

melodie at swissjabber dot ch - IRC #pclinuxos-fr sur freenode

Offline melodie

  • Hero Member
  • *****
  • Posts: 5942
  • XMMP=Jabber, free instant messaging protocol !
    • PCLinuxOS Fr
Hello,

I added the file as a link to a web area for download, in the first post.



« Last Edit: January 30, 2010, 12:51:15 PM by melodie »
melodie at swissjabber dot ch - IRC #pclinuxos-fr sur freenode