Puppy documentation needs updated or replaced

[bigpup]

Totally misunderstand what I suggested as something to add to puppy help.
Never said anything about deleting anything already there and accessible with out the Internet.

Read this post
viewtopic.php?p=72274#p72274

I agree about documentation being always lagging.
No one wants to do it!

-----------------------------------------------------------------------------------------------------------------

I updated the first post and provided a list of the files that need to be edited and updated.

I am almost having some fun!

[wizard]

@williwaw
@bigpup

what if "Getting Started and System Requirements" gets updated to be accurate for a different puppy?

All of the topics that include step by step instructions are referenced to one of these recommended distros:

Mainline Distro's:
- Dpup Stretch 7.5 for 32bit computer
- Fossapup64 9.5 for 64bit computers

Remasters with some extras and better new user help files:
- Friendly-Bionic32 for 32bit computer
- Friendly-Fossa64 for 64bit computers

Help files for other distros would need to be placed in their own topic.

I do agree that the help files should be embedded in the distro when possible since that insures both availability and correctness.

I have most of the files in "Getting Started and System Requirements" in .doc form. Converting them into HTML format would be very time consuming. Consider this as an alternative. Put those existing .doc files into their own directory in usr/share/doc then just create a Menu entry and a desktop icon for them. I don't think this would even have to involve woof-ce and could be simply added by the dev.

An example of this structure are the added help files for Friendly-Fossa64 and Friendly-Bionic32.

Thanks
wizard

[mikewalsh]

@wizard :-

If any of our available word processors can create "hyperlinks", then you can use the existing .doc format.....because a hyper-link can be pointed to anywhere in the file-system.

I keep suggesting this as an easy workaround, and everyone apparently keeps ignoring it in favour of more complicated solutions. This is Puppy. Puppy keeps it small & simple. Let's keep the documentation the same.....and keep it "local".

And this way, more folks can help to work on the documents themselves.....after all, didn't somebody mention, further back in the thread, that everyone knows how to use a word-processor?

Just my two-penn'orth.....FWIW.

Mike.

[williwaw]

@bigpup
sometimes just mean simply, sometimes it means exclusively. my bad

looking at index.html.top and index.html.bottom. didnt see an index.htm
not sure what you see that needs to be updated

Welcome to DISTRO_NAME version DISTRO_VERSION, released PUPPYDATE!

PLEASE READ: Release Notes for DISTRO_NAME DISTRO_VERSION

DISTRO_NAME help
All DISTRO_NAME's local documentation is in HTML or plain text format and located in /usr/share/doc. This page is the master index.
DISTRO_NAME-specific help
HOWTO get onto the Internet (dial-up your ISP)
HOWTO view and edit Microsoft documents
HOWTO multimedia (work with graphics, sound, video)
HOWTO regular expressions (what they are, how to use)
HOWTO print with Samba and CUPS
HOWTO use the Puppy Package Manager
HOWTO Internationalization (support non-English languages)
About Devx The Puppy development environment
About Gtkdialog The Puppy Linux GUI builder
About root (administrator) and spot

Note that although DISTRO_NAME has Busybox, which is a very small toolkit of utility applications, in some cases they do not have the required functionality and are replaced by the full versions. These replacements include: modprobe, cat, cp, gzip, gunzip, losetup, ls, mkdir, mv, rm, sed, sort, tar, wget, date, find, grep, fgrep and egrep.
Note that DISTRO_NAME applications are open source and are provided under various GPL licences. Any exceptions should be acknowledged in the /usr/share/doc/legal directory of the build.
Legal notice:
I, Barry Kauler, established the 'Puppy Linux Project' in January 2003, first website and product release 18-June-2003, and I have trademark claim to the name and typed drawing of 'Puppy Linux', 'PuppyOS' and 'Puppy' as it relates to "computer operating system software to facilitate computer use and operation", under Federal and International Common Law and Trademark Laws as appropriate.
Programs in Puppy are open source (except where noted above), and licences of individual products are duly acknowledged. The name Puppy Linux", also known as "Puppy" and "PuppyOS", and all artistic creations thereof, are copyright © 2003,2004,2005,2006,2007,2008,2009,,2010,2011,2012,2013 Barry Kauler -- further details in the online FAQ.
In late 2013 a number of Puppy developers took over development of Puppy Linux due to Barry Kauler's retirement, lead by myself, Michael Amadio.

Disclaimer:
Very simple, use entirely at your own risk. Neither Barry Kauler, Michael Amadio nor any of the Woof-CE team accepts any liability or responsibility whatsoever, and you use Puppy with this understanding. Licence
GNU GPL Version 2
GNU GPL Version 3
Lesser GPL
Puppy Legal Statement

[user1234]

@wizard :-

If any of our available word processors can create "hyperlinks", then you can use the existing .doc format.....because a hyper-link can be pointed to anywhere in the file-system.

I keep suggesting this as an easy workaround, and everyone apparently keeps ignoring it in favour of more complicated solutions. This is Puppy. Puppy keeps it small & simple. Let's keep the documentation the same.....and keep it "local".

And this way, more folks can help to work on the documents themselves.....after all, didn't somebody mention, further back in the thread, that everyone knows how to use a word-processor?

Just my two-penn'orth.....FWIW.

Mike.

Why don't you learn HTML? I am sure you'll get it in an hour. Start reading from https://www.w3schools.com/html/html_basic.asp and read till HTML lists in the website. I think that is more than required for working with puppy documentation files.

[user1234]

@bigpup, forgot to mention earlier, I had changed manual.css as well, so as to make the things look better. Just colors of the links changed and made the background of the webpages have white color.

[user1234]

Note:
If you think some needed info file is missing.
We can add it.

These files need edited and updated that are located in /usr/share/doc

cups_shell.htm

forums.htm

home.htm -> (working on by bigpup)

HOWTO-internationalization.htm

HOWTO_Internet.htm

HOWTO-microsoft.htm

HOWTO_modem.htm

HOWTO-multimedia.htm

HOWTO-regexps.htm -> (completed by usr1234)

index.html

index.html.top

installation.htm

net_setup.html

I have completed HOWTO-microsoft.htm as well. Read comment at https://github.com/puppylinux-woof-CE/woof-CE/pull/3598 to see all the updated files.

[user1234]

@bigpup:-
Updated forums.htm as well. There was pretty much nothing to be updated, but I had a feeling that all external links should be opened in a new tab. So updated the file with those changes. Here is the file:-

forums.htm.tar.bz2

(1.2 KiB) Downloaded 36 times

(use tar -xvjf forums.htm.tar.bz2 to extract.)

EDIT: Just saw that index.html.top did not have any link to forums.htm. So added it. Here is the modified index.html.top:-

index.html.top.tar.bz2

(1.31 KiB) Downloaded 23 times

(use tar -xvjf index.html.top.tar.bz2 to extract.)

[user1234]

@bigpup:-

Updated gtkdialog.htm. Here is the file (contains an image file as well):-

gtkdialog.tar.bz2

(167.11 KiB) Downloaded 44 times

(use tar -xvjf gtkdialog.tar.bz2 to extract.)

[puppy_apprentice]

Manual in PDF with config files necessary for Prince.
Manual
Size: 1,31 MB

Forum articles could be adjusted to looks better in PDF like use for this sentence

Need more help? Join the forum and post your questions in Beginners Help.

the same font and style.

Max width for screenshots should be 500px to fit the page, i've used this CSS style:

Code: Select all

img {text-align: left; width: 100%; max-width: 500px}

to scale big pictures but in the same time the smaller ones width got increased.

[user1234]

@bigpup:-
Updated few network pages. Am posting the whole doc folder now (apologies). Open up index.html.top > HOWTO get onto the Internet and tell if whether the work I have done contains any error, especially connecting to wired internet using sns (never done that, just a blind guess).

The file is bigger than accepted size by the forum, so used github to put it as a release in my other repo which is just a waste .

Download the file from here.

[bigpup]

Well, I guess if you are going to keep updating files at this speed.

Just let us know when you are done.

You have already updated ones I was going to work on.

I still think for review, it would be better to attach each individual file to a post.

Thanks for jumping in and working on this issue!!

[user1234]

Well, I guess if you are going to keep updating files at this speed.

Just let us know when you are done.

You have already updated ones I was going to work on.

I still think for review, it would be better to attach each individual file to a post.

Thanks for jumping in and working on this issue!!

Thanks @bigpup! I am not doing much. I just try to fix broken links and do a bit of changes. If you'd see, there are just ~180 LOCs added and ~45 removed , not much of a difference. But I think this is my saturation point. I never have used anything else than this so as to update the documentation for those. Will very soon open up the pull request. By then, review the changes from the link I gave earlier, and see if everything is good. I was also worried about the size of the images I currently added, so I tried to shrink them. Now most of them are under 100KBs.

[bigpup]

@bigpup
sometimes just mean simply, sometimes it means exclusively. my bad

looking at index.html.top and index.html.bottom. didnt see an index.htm
not sure what you see that needs to be updated

Should be seeing an index.html file.

I think the stuff to check on it is that all the links go to the correct location.

The HOWTO write programs link is not working.

This one link is all I see wrong in it.

All the others seem OK, As long as the file, the clickable link points to, is there to find.

I do wonder if more links, to other files, need to be added.

That index.html file, gets updated to indicate the Puppy version, it is in.
Some of the statements, get changed to reflect the Puppy version.
The rest of the file is the same, all the time.
I am not sure, how that Puppy version info gets changed. Maybe by it;s developer, when building a Puppy version.

[wizard]

@user1234

Reviewed HOWTO_Internet.htm, looks good, very nice work.

Thanks
wizard

[bigpup]

Here is a updated home.htm

All the links go to correct locations.

home.htm.zip

(1.58 KiB) Downloaded 27 times

The only thing I was not sure about.
Should that link to Barry K's blog be there or not.
It is about stuff he is doing, but not exactly Puppy Linux anymore.
.

[wizard]

@mikewalsh

If any of our available word processors can create "hyperlinks"

There are currently some issues with hyperlinks that have to be worked around. I'll cover that in another topic.

Thanks
wizard

[user1234]

@user1234

Reviewed HOWTO_Internet.htm, looks good, very nice work.

Thanks
wizard

Thankful that you liked it! I suppose that you have checked HOWTO_sns.htm as well (that one is the one I'm not very good at)?

Just looked at HOWTO_dialup.htm as well, the one I renamed. Seems like it had a broken link. Tried to correct it, but having no knowledge in the field, I ask you, @bigpup and @wizard, if this file is okay or not:-

HOWTO_dialup.htm.tar.bz2

(6.3 KiB) Downloaded 41 times

[bigpup]

@user1234

Reviewed HOWTO_Internet.htm, looks good, very nice work.

Thanks
wizard

I looked it over also.

Very nice update!

The only maybe an issue, is the Puppy version is going to have to have sns, as an available program.
Well, most all do!

I am seeing some developing versions of Puppy offering a completely new program to use.
Well maybe that will be an update later.

I wonder if something about your Ethernet or WIFI hardware, not being detected, would be good to add to it.

[bigpup]

checked HOWTO_sns.htm

Very nice and informative how to!

Everything looked good to me.

Being nit picking.

Should this be added?
When asked to make this the default connection?
Should say yes.

[bigpup]

Just looked at HOWTO_dialup.htm as well, the one I renamed. Seems like it had a broken link.
Tried to correct it, but having no knowledge in the field, I ask you, @bigpup and @wizard, if this file is okay or not:-

I will look it over.
But I have not used dialup for a very long time.

Maybe someone, that has used dialup, will come along, and can offer advice.

[user1234]

The only maybe an issue, is the Puppy version is going to have to have sns, as an available program.
Well, most all do!

We could add disclaimer something like, 'if available'. Yes, update will be needed later on. I'll try building and using jammypup to see which one woof-CE currently would use. But it wouldn't be possible on my current laptop as there is no space on it to download the iso. Maybe someone else could do that?

I wonder if something about your Ethernet or WIFI hardware, not being detected, would be good to add to it.

Could you please provide me with the content? I have no idea how to do that.

When asked to make this the default connection?
Should say yes.

Thanks! I'll do that.

[bigpup]

bigpup post_id=72528 time=1668359172 user_id=1095]
I wonder if something about your Ethernet or WIFI hardware, not being detected, would be good to add to it.

Could you please provide me with the content? I have no idea how to do that.

I will work on it and get back with what I think could be added.

Give me a day.

Life is getting in the way right now.

Note:
Anyone else can offer something for this.
There are others out there that know this probably better than I do.
What to do if the Ethernet and WiFi hardware is not detected.

[williwaw]

Should be seeing an index.html file.

I think the stuff to check on it is that all the links go to the correct location.

The HOWTO write programs link is not working.

This one link is all I see wrong in it.

All the others seem OK, As long as the file, the clickable link points to, is there to find.

I do wonder if more links, to other files, need to be added. :idea:

That index.html file, gets updated to indicate the Puppy version, it is in.
Some of the statements, get changed to reflect the Puppy version.
The rest of the file is the same, all the time.
I am not sure, how that Puppy version info gets changed. Maybe by it;s developer, when building a Puppy version.

Should be seeing an index.html file.
I am looking at https://github.com/puppylinux-woof-CE/w ... /share/doc and only see index.html. top and index.html.bottom. Are you saying they should be combined to a single file, index.html?

The HOWTO write programs link is not working
I do not see the link in the index.html.top or .bottom at https://github.com/puppylinux-woof-CE/w ... /share/doc
what is the url you see it at?

I do see a broken FAQ link in index.html.bottom that I will edit to https://puppylinux-woof-ce.github.io/faq.html

I do wonder if more links, to other files, need to be added. :idea:
should there be a link added to this document to point to any other help information or sites?

That index.html file, gets updated to indicate the Puppy version, it is in.
Some of the statements, get changed to reflect the Puppy version.
The rest of the file is the same, all the time.
I am not sure, how that Puppy version info gets changed. Maybe by it;s developer, when building a Puppy version.
DISTRO_NAME, DISTRO_VERSION and PUPPYDATE are variables defined by the dev when a woof-ce build is run?

[wizard]

@user1234
@bigpup

bigpup wrote: ↑Sun Nov 13, 2022 11:06 am

I wonder if something about your Ethernet or WIFI hardware, not being detected, would be good to add to it.

Could you please provide me with the content? I have no idea how to do that.

Look at the internet connection doc from "Getting Started and System Requirements"
viewtopic.php?t=5483

wizard

[user1234]

DISTRO_NAME, DISTRO_VERSION and PUPPYDATE are variables defined by the dev when a woof-ce build is run?

I think, yes. Atleast its set for DISTROSPECS file, and the process should be automated for the docs as well, I suppose. I think the files named as .top and .bottom should also get merged after a build.

@user1234
@bigpup

bigpup wrote: ↑Sun Nov 13, 2022 11:06 am

I wonder if something about your Ethernet or WIFI hardware, not being detected, would be good to add to it.

Could you please provide me with the content? I have no idea how to do that.

Look at the internet connection doc from "Getting Started and System Requirements"
viewtopic.php?t=5483

wizard

Thanks! I get it. Just add a statement allowing the user to know about the forums, and letting them ask about the issue on it, if their hardware is not detected, or if the get unsuccessful results after trying to connect.

[bigpup]

Added info about your Ethernet or WIFI hardware, not being detected.

Thanks! I get it. Just add a statement allowing the user to know about the forums, and letting them ask about the issue on it, if their hardware is not detected, or if the get unsuccessful results after trying to connect.

That was the idea I was going to post.

After looking at what could be given for info.

Just tell them to go to the forum for help.

Do suggest you put the actual forum web address written out.
https://forum.puppylinux.com/
Or
forum.puppylinux.com

They will have to use this in some other operating system or another computer.

Trying to explain exactly what to do, really is going to need a post in the forum, by the person with the problem.

[bigpup]

About the index.html file

I was actually looking at what is in a Puppy version usr/share/doc not what is at Woof-CE.

I guess, the index.html.top and index.html.bottom, get used somehow to produce a index.html, for the specific Puppy version.
Maybe the developer of the Puppy version, makes this index.html file

The HOWTO write programs link is not working

I was looking at a specific index.html file in a specific Puppy version.
I think that link got added for that specific Puppy version.
So, index.html seems was produced by that Puppy version developer or they did edit it.

So, I guess looking at the top and bottom files and correcting any links in them, is what is needed.

[dimkr]

Maybe the developer of the Puppy version, makes this index.html file

https://github.com/puppylinux-woof-CE/w ... all.sh#L24

Lines 24-59

[user1234]

Maybe the developer of the Puppy version, makes this index.html file

https://github.com/puppylinux-woof-CE/w ... all.sh#L24

Lines 24-59

That's what I had been thinking all this time. But I still don't understand, why are the files index.html and release-skeleton.html divided into .top and .bottom? I mean if they are going to merge later on, and (supposedly) similar content is to be replaced in both the files, then why not keep a single file instead of two different files?

Please tell if my supposition is wrong.