Puppy documentation needs updated or replaced

[bigpup]

I updated the cups_shell.htm

Added a little info about getting drivers from the manufactures driver support web sites.

Provided some links to this forum for drivers and help.
Deleted the links to the old forum, that really were not good info anymore.

My version:

cups_shell.htm.zip

(1.78 KiB) Downloaded 143 times

[bigpup]

@user1234

I looked over your version of the devx.htm

Really like those how to images for loading it.

I did a very minor edit of the names you had for Bionic and Fossa.
Made them Bionicpup64 and Fossapup64.
Reason for this is Bionicpup32 does not have Quickpet and there is a fossa something posted someplace in the forum that is not Fossapup64.

Added a info statement about how to unload the devx.sfs using SFS-load-on-the-fly program.

My version:

devx.htm.xz

(2.15 KiB) Downloaded 161 times

.

[bigpup]

@user1234

I am looking at the files you have in the last doc directory you posted.

I just found out that the icons and a few other files (.css) have to be in place in the location you get the htm or html file from.

I looked at the home.htm file you had and it was the old one, with bad links.

Here is my updated one:

home.htm.zip

(1.58 KiB) Downloaded 1397 times

.
The link at the bottom of it is for the index.html and you do not have one of those in your doc directory.
So it comes up with bad link.

Did you ever figure out if a index.html file is needed or that it gets generated from the index bottom and top files, when building a Puppy version?

[user1234]

@user1234

I am looking at the files you have in the last doc directory you posted.

I just found out that the icons and a few other files (.css) have to be in place in the location you get the htm or html file from.

I looked at the home.htm file you had and it was the old one, with bad links.

Here is my updated one:
home.htm.zip
.
The link at the bottom of it is for the index.html and you do not have one of those in your doc directory.
So it comes up with bad link.

Did you ever figure out if a index.html file is needed or that it gets generated from the index bottom and top files, when building a Puppy version?

Well, I had not updated the PR with your files. I'll do that now.

As far as index.html is concerned, @dimkr had posted on this topic which explains that index.html.top and index.html.bottom will be merged later on (with some additional file if provided by the developer on build time of a puppy) while building a puppy. So there must be links to index.html and not index.html.top in any file (we look at the end results, not the intermediate ones).

Also note that pictures and css files need not be in the same directory as the html file is in. You can directly provide a link to that picture/css file in the html file. The link to that picture/css file would be of same format as the OS lists them. So, for example- /dev/null, ./file.css (or file.css), directory/file.css, etc.

[user1234]

I updated the cups_shell.htm

Added a little info about getting drivers from the manufactures driver support web sites.

Provided some links to this forum for drivers and help.
Deleted the links to the old forum, that really were not good info anymore.

My version:
cups_shell.htm.zip

I reviewed the file. I have some suggestions:-

1. For example, I needed a driver for my Brother HL2040 laser printer -- it was located, and I have put it permanently into Puppy -- look at /usr/share/cups/model/Brother-HL-2040-hl1250.ppd if you are curious what a printer driver file looks like. Note that the file has extension .ppd.

   /usr/share/cups/model/Brother-HL-2040-hl1250.ppd is not found in fossapup64. What's the case?

2. Few links could be made to open in a new tab (preferably external ones only) using this attribute with <a>:-

   Code: Select all

   <a target="_blank">
   

   But leave that to me. I'll update that later on.

I have merged the other two files in the PR . Thanks !!!

[williwaw]

Here is my updated one:
home.htm.zip

Hey big pup,
somehow DISTRO_NAME got replaced with fossapup64 a couple of times in the file posted above
otherwise looks good!

[bigpup]

For example, I needed a driver for my Brother HL2040 laser printer -- it was located, and I have put it permanently into Puppy -- look at /usr/share/cups/model/Brother-HL-2040-hl1250.ppd if you are curious what a printer driver file looks like. Note that the file has extension .ppd.

@user1234
/usr/share/cups/model/Brother-HL-2040-hl1250.ppd is not found in fossapup64. What's the case?

I saw that statement in the cups_shell.htm and I think it would be best to just remove it.
I started to remove it and the idea I had was it an example or what?

It does seem to just be confusing info.

Could maybe do this edit to the statement part as example of where the driver file goes.

Puppy has the Gutenprint package, which has a lot of printer drivers. However, if your printer is not among them, you may be able to find a driver online.
Example: I needed a driver for my Brother HL2040 laser printer -- it was located and I have put it permanently into Puppy at -- /usr/share/cups/model/Brother-HL-2040-hl1250.ppd. (The needed file will have a extension .ppd).

[bigpup]

Here is my updated one:
home.htm.zip

Hey big pup,
somehow DISTRO_NAME got replaced with fossapup64 a couple of times in the file posted above
otherwise looks good!

Good catch!

I must have gotten the original file from Fossapup64 I was working on it in.

Now you know why I ask another set of eyes looking over what I produce!

I was trying to get good links and not really looking at the statements that close.

[bigpup]

Looking over the HOWTO-multimedia.htm

Most of it is bad links and talking about software not around anymore.

I think that chart originally was from very early days of Puppy Linux.

Any ideas what to do with this file?

I was thinking scrap the whole thing and start over new.

Maybe just talk about usual stuff that most Puppy versions will have and what they are for.

[williwaw]

@bigpup

what are your thoughts on me doing a rewrite on the upper part of installation.html. I could post an edited version sometime after turkey day, and perhaps you could be induced to add more detailed info and possibly some how tos or step by steps {with pics?) of the different installers in the last section.

[user1234]

Looking over the HOWTO-multimedia.htm

Most of it is bad links and talking about software not around anymore.

I think that chart originally was from very early days of Puppy Linux.

Any ideas what to do with this file?

I was thinking scrap the whole thing and start over new.

Maybe just talk about usual stuff that most Puppy versions will have and what they are for.

I also do think the same thing. I am now correcting that typo-bug in home.htm, then will edit forums.htm. If you want, I will do HOWTO-multimedia as well. Reconverting the PR to draft for now. I think it might be better to add everything at once.

For example, I needed a driver for my Brother HL2040 laser printer -- it was located, and I have put it permanently into Puppy -- look at /usr/share/cups/model/Brother-HL-2040-hl1250.ppd if you are curious what a printer driver file looks like. Note that the file has extension .ppd.

@user1234
/usr/share/cups/model/Brother-HL-2040-hl1250.ppd is not found in fossapup64. What's the case?

I saw that statement in the cups_shell.htm and I think it would be best to just remove it.
I started to remove it and the idea I had was it an example or what?

It does seem to just be confusing info.

Could maybe do this edit to the statement part as example of where the driver file goes.

Puppy has the Gutenprint package, which has a lot of printer drivers. However, if your printer is not among them, you may be able to find a driver online.
Example: I needed a driver for my Brother HL2040 laser printer -- it was located and I have put it permanently into Puppy at -- /usr/share/cups/model/Brother-HL-2040-hl1250.ppd. (The needed file will have a extension .ppd).

It is supposed to be an example file. So why not include a newer one in the docs? Needs not be Brother-HL-2040-hl1250.ppe only, could be something else as well; it just needs to be a driver for printer (or whatever the example is for).

Not doing anything with it as I have no experience with a printer.

EDIT: Fixed home.htm issue. Here is the final result:-

home.htm.tar.bz2

(1.66 KiB) Downloaded 205 times

EDIT: Updated forums.htm, and deleted forums.css. Here is the forums.htm:-

forums.htm.tar.bz2

(1.33 KiB) Downloaded 147 times

@bigpup, @williwaw, please check for any other issue.

[user1234]

As for latest internet software is concerned, I recorded it here (in self built jammy64):-

As I was using qemu to run it, I could not do this with wireless. Will do that later on, by installing the puppy to hard drive. Will also write a documentation file for this.

EDIT: Tried using net tool (whatever its name is) in newer puppy. It is now very easy to connect to internet! Seems like it is a major update. Couldn't shoot the video here, otherwise would've shot one. Will update the documentation very soon.

BONUS: I was able to see our work done on the docs as well in this build , as I had built it earlier only, that too with my github fork. So all updates were there. Just worried to see that the docs didn't look as expected, maybe because the distro used netsurf (which seems to be IE of linux ). Will try to see the docs by installing palemoon in it.

[bigpup]

@user1234

Thanks for correcting that error I made on my version of home.htm

I just got a chance to work on it, but I see you already did it.

Thanks!

Life is keeping me doing other stuff and I am not able to work on this as quickly as I want to.

I will look over your corrected home.htm and forums.htm

See if your eyes are working better than my eyes and brain.

If you want, I will do HOWTO-multimedia as well.

Yes please.
You have good ideas on how these files should look.
I think I would be some help to you, if I look over what you produce, and offer ideas on what you could change or add.

Reconverting the PR to draft for now. I think it might be better to add everything at once.

Yes, I agree that would be a good way to do it.

[bigpup]

@bigpup

what are your thoughts on me doing a rewrite on the upper part of installation.html. I could post an edited version sometime after turkey day, and perhaps you could be induced to add more detailed info and possibly some how tos or step by steps {with pics?) of the different installers in the last section.

sure, go for it!

Any idea is something to look at and consider.

Not exactly sure what you want to do to the upper part, with it only being clickable links to the different sections of the displayed page.

My thoughts on providing how to or step by step for the installers.
Each program has it's own help in the program.
Most give guidance as you use them.
So, I am not sure more is needed.
To really provide a good how to, it would turn into a very large single page or multiple pages.

One good thing about Puppy designed programs.
Most people that produce them, put the help into the program as you use it.
Telling you stuff you need to know, as you use the program.

The one Puppy installer program I helped on to produce.
We tried to anticipate places that would be hard to understand what to do and just put info statements there to guide people.
We did make a small help you could click on.
But instead of one big help file you had to read.
At each window of the program, there was a help button.
Click it and help was provided, only about what you do in that window of the program.
That is Puppy software!

[bigpup]

@user1234

Looked over your last posted forums.htm

Found one word misspelled see image.

Should those link:- be showing above the first two or are those suppose to be some icon?
.

Screenshot(3).jpg (116.47 KiB) Viewed 2366 times

[user1234]

Should those link:- be showing above the first two or are those suppose to be some icon?

They are just 'texts'. But now I think I should promote them to a heading (maybe h3). And thanks for pointing the typo out. I'll fix both issues.

[williwaw]

Not exactly sure what you want to do to the upper part, with it only being clickable links to the different sections of the displayed page.

sorry, not index html, but installation html. it has no upper or lower just the single file. I was confusing it with index.html

So, I am not sure more is needed.

ok

@all
I'm looking at html documentation for other projects and see various ways to construct documents. For example https://www.claws-mail.org/manual/claws ... anual.html
is presented as a single document where the table of contents consists of links that take you to the appropriate section of a long page.

Are there pros and cons to having a longer single page vs dividing topics into multiple pages for simple documentation ?

[user1234]

Not exactly sure what you want to do to the upper part, with it only being clickable links to the different sections of the displayed page.

sorry, not index html, but installation html. it has no upper or lower just the single file. I was confusing it with index.html

So, I am not sure more is needed.

ok

@all
I'm looking at html documentation for other projects and see various ways to construct documents. For example https://www.claws-mail.org/manual/claws ... anual.html
is presented as a single document where the table of contents consists of links that take you to the appropriate section of a long page.

Are there pros and cons to having a longer single page vs dividing topics into multiple pages for simple documentation ?

I'd vote for a single page with links to different sections (which is there already in installation.htm).

[user1234]

@bigpup, @williwaw:-

I updated forums.htm:-

forums.htm.tar.bz2

(1.33 KiB) Downloaded 241 times

I updated manual.css as well (changed 100vw to 100% width, what is really needed):-

manual.css.tar.bz2

(876 Bytes) Downloaded 183 times

[dimkr]

in self built jammy64

You can build dpup (x86_64/debian/bullseye64) if you want to use something rock solid with a "big" browser (Firefox). Usually, that's what I do when I need to test a woof-CE change quickly.

[user1234]

in self built jammy64

You can build dpup (x86_64/debian/bullseye64) if you want to use something rock solid with a "big" browser (Firefox). Usually, that's what I do when I need to test a woof-CE change quickly.

Thanks for advice, but I wanted to work on jammy64, and have resources limits. The hard drive I am working on has crashed earlier as well (now using only end 20-30GiBs of the drive, hoping for no bad blocks there), nearly for 10 times, and then I had to re-install everything. Puppy runs fine without giving any errors. But last time it crashed, was on a KLV (don't know particularly the reason, same thing used to happen with kubuntu, so I switched to puppy).

So, dpup.... no!

Also note that if I hadn't used jammy here, this PR would not have been possible .

[bigpup]

presented as a single document where the table of contents consists of links that take you to the appropriate section of a long page.

It could be, but this is why I do not like them.

Notice in this image, I selected the introduction, and it took me to that section of the page.
With the introduction at the top.

But it also shows other sections of the page.

To me. That other stuff is visual distraction from what I selected to look at.
.

Screenshot(2).jpg (122.51 KiB) Viewed 2448 times

[bigpup]

@bigpup, @williwaw:-

I updated forums.htm:-
forums.htm.tar.bz2

I updated manual.css as well (changed 100vw to 100% width, what is really needed):-
manual.css.tar.bz2

Looked at this version of the forums.htm
In the first statement at the top is rokedge name in blue.
It is a clickable link that takes me to the login screen for this forum.
(See image attached)

Note:
I see it is suppose to link to memberlist.php?mode=viewprofile&u=2
However, to see this correctly, I think you need to be actually logged into the forum.
I had to first be logged into the forum, to get the link to show his profile page.

I think it should just be the name rockedge and nothing else.
.

Screenshot(4).jpg (47.77 KiB) Viewed 2433 times

[user1234]

@bigpup, @williwaw:-

I updated forums.htm:-
forums.htm.tar.bz2

I updated manual.css as well (changed 100vw to 100% width, what is really needed):-
manual.css.tar.bz2

Looked at this version of the forums.htm
In the first statement at the top is rokedge name in blue.
It is a clickable link that takes me to the login screen for this forum.
(See image attached)

I think it should just be the name rockedge and nothing else.
.
Screenshot(4).jpg

Interesting! That link should have taken us to rockedge's profile page. I'll fix that.

[bigpup]

I just added a note to my post.

I see it is suppose to link to memberlist.php?mode=viewprofile&u=2
However, to see this correctly, I think you need to be actually logged into the forum.
I had to first be logged into the forum, to get the link to show his profile page.

Just tried a few other locations on the forum.
Some will not come up unless you are logged into the forum.
In fact, some will not even show in the forum, unless you are logged in.

Look at what is clickable at the bottom right of the main forum page.
When logged in and not logged in.
Not the same stuff is there to click on.

[bigpup]

Looked at the HOWTO-internationalization.htm

All the Puppy specific location links in it are no good.

Only two links work and they are for info about what a PO file is, what a translator program does.

I do not think there are still specific people doing Puppy translations.

Really need someone that does this translation stuff, to look this over, and offer suggestions on what it may need.

I have never done translations or even used MoManager program.

Anyone out there who knows this stuff that can look this file over and offer advice:
What links would help?
Is information correct?

[williwaw]

I updated manual.css as well (changed 100vw to 100% width, what is really needed):-
manual.css.tar.bz2

@user1234
Thanks for continually fine tuning manual.css. I have added the .css to this preliminary single file template for not only installation.html, but what I hope can become index.html once I consolidate the contents of the various .htmls in /usr/share/doc with other tutorials found mostly on the forum.

If anyone has a suggestion for other documentation not found in /usr/share/doc to be included, it will be welcomed.

As big pup mentioned, the single file format does allow one to see documentation posted further down on the page, however I feel that is an acceptable trade off if the documentation can be simplified enough for a noob like myself (or others with an entry level understanding of html) can easily continue to help maintain puppy documentation going forward.

The template thus far, temporarily named pupindex.html can be found at https://github.com/wlwaw/pupindex
your comments are appreciated.
The content itself at this point is a placeholder until a comprehensive Table of Contents can be outlined. You should be able to open pupindex.html from your downloads folder once you unpack the .zip
no need to import to usr/share/docs

[user1234]

I just added a note to my post.

I see it is suppose to link to memberlist.php?mode=viewprofile&u=2
However, to see this correctly, I think you need to be actually logged into the forum.
I had to first be logged into the forum, to get the link to show his profile page.

Just tried a few other locations on the forum.
Some will not come up unless you are logged into the forum.
In fact, some will not even show in the forum, unless you are logged in.

Look at what is clickable at the bottom right of the main forum page.
When logged in and not logged in.
Not the same stuff is there to click on.

Thanks! That means that I'll have to remove all similar links. Rather add description that the name is of a forum member.

EDIT: I have done the changes successfully. Will not be providing the files as just the links to users have been changed. But will surely update the doc.tar.bz2 at https://github.com/lakshayrohila/woof-CE/releases.

[user1234]

manual.css is the file that css stylesheet that is meant to be used with each and every html file. It provides all the styles that are common to all html files.

The template thus far, temporarily named pupindex.html can be found at https://github.com/wlwaw/pupindex
your comments are appreciated.
The content itself at this point is a placeholder until a comprehensive Table of Contents can be outlined. You should be able to open pupindex.html from your downloads folder once you unpack the .zip
no need to import to usr/share/docs

Seems great . This could be 'documentation for docuemntation' . Why not open up a github gist (or a wiki in woof-CE) that explains the html format, and then keep this as examples? Then link to it could be added in the puppylinux website as contributing to docs. I think we'll manage to do that... some day .

[bigpup]

@williwaw

Took a look at your pupindex.html

Keep going with it and let's see what it turns into.

It maybe could be the best way to go with all of this documentation.

My earlier post was only stating a minor thing I did not like about this type of information file format.

Overall, it is a very useful document format!

I wonder if there could be some type of code that would let it only go to the selected section and only show that section?

I seem to remember using some info document that did that.

I am going to look around the Internet and see if I can find one.

Update:
I found one that fills the complete screen with only the section you selected to go to.
It did it, because there was enough statements and info to require down scrolling the screen to see it all.
So the next section could not be seen unless you down scrolled.
This was it the help for Pburn program that is in most Puppy versions.

I edited your pupindex.html
Made the amount of info in the introduction a lot more.
When you click on the introduction link at the top and it goes to introduction.
That is only section of the form you see.
Here is my hack so you can see what I did.

pupindex.html.zip

(4.53 KiB) Downloaded 137 times