Difference between revisions of "User talk:Vater"

From PC-BSD Wiki
Jump to: navigation, search
Line 50: Line 50:
 
Here is a response to some of those questions:
 
Here is a response to some of those questions:
 
# The [[PC-BSD Wiki:Style Guidelines#External Hypertext Links]] is all wiki markup, although part of it does look like html because it uses <nowiki>< and ></nowiki> to enclose some things. I need to make parts of it bold to better clarify it. In addition to this, there are certain situations where it truly is a mix of wiki markup and html, such as the [[Wiki Site TODO]] page.
 
# The [[PC-BSD Wiki:Style Guidelines#External Hypertext Links]] is all wiki markup, although part of it does look like html because it uses <nowiki>< and ></nowiki> to enclose some things. I need to make parts of it bold to better clarify it. In addition to this, there are certain situations where it truly is a mix of wiki markup and html, such as the [[Wiki Site TODO]] page.
# At the moment, I do not believe there is a specific rule already being followed for when to use numbered lists. It would make sense to use them for specific step-by-step instruction, however, I do not believe that this is used much at all. I will have to skim through the handbook to see how it might best be used and clarify the conditions that would necessitate it.
+
# At the moment, I do not believe there is a specific rule already being followed for when to use numbered lists. It would make sense to use them for specific step-by-step instruction, however, I do not believe that this is used much at all. I believe that the primary method of describing processes is entirely with words rather than numbered lists. I will have to skim through the handbook to see how it might best be used and clarify the conditions that would necessitate it.
 
# I suspect (without looking at it right now) that the [[EasyPBI]] page having been written almost entirely by someone that doesn't usually edit the handbook, is a bit of a mess or follows completely different style. I will have to look it over a bit to be able to make any suggestions.
 
# I suspect (without looking at it right now) that the [[EasyPBI]] page having been written almost entirely by someone that doesn't usually edit the handbook, is a bit of a mess or follows completely different style. I will have to look it over a bit to be able to make any suggestions.
 
# Beware, there are templates of various format on the wiki, including more than one way to make the tables. The intent with all variants is to eventually simplify and speed up editing. I will have to set aside somewhere to indicate which templates have been depreciated, or perhaps simply a "depreciated" category tag for those.
 
# Beware, there are templates of various format on the wiki, including more than one way to make the tables. The intent with all variants is to eventually simplify and speed up editing. I will have to set aside somewhere to indicate which templates have been depreciated, or perhaps simply a "depreciated" category tag for those.

Revision as of 22:47, 8 July 2012

Hello!

I added some content to the 'text' section of the guidelines page that you asked about. It is still rather sparse. I suppose that part of the reason for this is that much of the site edits have been handled by Dru and myself. She mostly adding the content and usually images, and basically being the editor of the resulting handbook. I have tried to make improvements in other areas and have done some edits and image uploads (which I also tried to document some best methods).

If you have further thoughts on any part of this process, including wiki templates, wiki documentation, and anything else, I am willing to listen. I feel that what we should strive for, is a level nearing wikipedia. There are still many things that can be improved, especially things that would make an editor's job easier, shorter, or more intuitive. You found the style guidelines page, which means either it made sense to seek it, or it is something normally found on a wiki site. I am not sure of all such pages, that is part of the reason why a lot of the editor documentation is missing.

I might suggest to explore the entire wiki site and see what is here already. The special pages are very helpful for discovering problems, such as double redirects and other faulty things. I have tried to have all handbook pages categorized, and all useful pages with one of the two headers.

--Tigersharke 02:48, 6 July 2012 (PDT)


You're doing fine. I looked at your change to 'security' and don't see any problems with the wording. Its good to have another active editor on the wiki. If you have any questions about the templates or suggestions for new templates, I'm willing to assist with them. Templates can be quite challenging to create, but I eventually succeed with my ideas.

As I said once before, I want editing the wiki to be as simplified as possible while also being as automated as possible, both are accomplished by well-designed templates. It will take time to finesse those solutions in template form, but eventually they will exist.

It also helps you and any other editor, to have written guidelines and other editor documentation. With these, we can remain consistent on the entire wiki site, not only the handbook portion of it.

I think I should set aside a space somewhere for the ideas I desire or plan for. I'll let you know when it exists and where.

Thank you for all your efforts!

--Tigersharke 13:39, 8 July 2012 (PDT)


Your request for "define numbering consecutively"- is this meant to be part of the Collation section of the style guidelines? I'm not sure if there is a certain 'best' or 'worst' way of doing it. Unless you have a certain example that you could give me to help with defining this in a general way?

--Tigersharke 13:39, 8 July 2012 (PDT)

I mean numbered lists (by using #).
The Style Guidelines are saying for Bullets that a hard enter between the items are needed (to ensure that the PDF and EPUB versions format correctly).
For example in Creating an Automated Installation with pc-sysinstall you can find the following code.

To create a custom installation, perform the following steps:

1. Text for step 1

2. Text for step 2

3. Text for step 3

These steps are discussed in more detail below.

And what is going on in EasyPBI?
An other variant (yes, i modified it also) is used in Printing#Manually Adding a Driver.
There is an other one in PC-BSD Wiki:Style Guidelines#External Hypertext Links. It is a mix of HTML and wiki-markup (or not?).
Please create rules for numbered lists. :-)
--Rg 21:07, 8 July 2012 (PDT)

Here is a response to some of those questions:

  1. The PC-BSD Wiki:Style Guidelines#External Hypertext Links is all wiki markup, although part of it does look like html because it uses < and > to enclose some things. I need to make parts of it bold to better clarify it. In addition to this, there are certain situations where it truly is a mix of wiki markup and html, such as the Wiki Site TODO page.
  2. At the moment, I do not believe there is a specific rule already being followed for when to use numbered lists. It would make sense to use them for specific step-by-step instruction, however, I do not believe that this is used much at all. I believe that the primary method of describing processes is entirely with words rather than numbered lists. I will have to skim through the handbook to see how it might best be used and clarify the conditions that would necessitate it.
  3. I suspect (without looking at it right now) that the EasyPBI page having been written almost entirely by someone that doesn't usually edit the handbook, is a bit of a mess or follows completely different style. I will have to look it over a bit to be able to make any suggestions.
  4. Beware, there are templates of various format on the wiki, including more than one way to make the tables. The intent with all variants is to eventually simplify and speed up editing. I will have to set aside somewhere to indicate which templates have been depreciated, or perhaps simply a "depreciated" category tag for those.

Thank you for your help and motivation toward getting things defined. It will help us all to stay consistent. I already now realize PC-BSD Wiki:Style Guidelines appears not to apply to itself.

--Tigersharke 22:42, 8 July 2012 (PDT)