User:Magill/Project-Documentation

From Lotro-Wiki.com
Jump to navigation Jump to search


Magill's Corner
  • This is a major issue I've been gnashing about since I started editing !!!


Magill's Corner Documentation

About this page

This page is primarily a collection of notes about things which need to be done.

Some are action items, which often have a status attached in color.
Some items are simply pages I either need to remember, or which have "obscure" names, but important information, and are not linked anywhere.

Pieces

  • The Great Documentation Project
Document/Update documentation for all of Lotro-Wiki.com
User:Magill/Project-Documentation
Lotro-Wiki.com:Documentation
  1. Modify the Welcome template {{Welcome}}
  2. Done: User:Magill/Project-Documentation-Help-reformat
  3. In progress: User:Magill/Sandbox-5 - Characterization
  4. Help:Introduction: Review, expand and integrate - Needs a conclusion, example images, and a final proofread -- added to live 26 Sept 2013
    • ...rest of Help section here...
  5. Update Category: Help
    Merge:
    1. Categorization Guideline Merged with
    2. Help: Categorization and Merged
    3. User:Magill/Sandbox-Create_a_region
      and then get that information into
    4. Lotro-Wiki.com:Categorization
    and then into the Help pages
  6. Separate Help into Novice and Expert sections...
    • On Novice pages, link explanations to the "Create pages."
    • On Expert pages, leave Creation section "as is."
  7. Write step-by-step (i.e. parameter-by-parameter) explanation of all templates
    1. Match boilerplates with templates -- Create Article Titles needs to be created
    2. Move all boilerplate into template/doc
    • Update/Write /doc files for all templates
  8. Article_Management_Tags - finish and clean-up -- Done
  9. Update entries for Lotro-Wiki.com:Administrators - Done
  10. Create an SOP manual for editors -- in progress Help:SOP for Editors
  11. Lotro-Wiki.com:Policy -- Renamed Help:Policy; content removed to Help:SOP for Editors
    This page needs to be renamed/eliminated as part of an expanded Policy section, probably in guidelines.
  12. Guidelines/Policies/Standards/Manual of Style -- Lotro Wiki Manual of Style
  • Wiki Markup/Editing Guides
Help
Boilerplates
Templates
The Template should always transclude the matching Template/doc and Preload files, which should also always be transcluded into the Boilerplate page!

Concepts

  1. This page is assumed to become the "lead" article in the Help Guidelines section.
    Alternative title: How to start modifying or creating pages
    ...trying to come up with a "intuitieve" name.
  2. I suspect (assume) that, in the process of updating and integrating all of the Guidelines articles, General Help articles, and a bunch of articles that are not linked to either section , all will be reviewed, updated and integrated.... probably including some sort of Category reorganization (as Zimoon has been doing).
  3. There probably should be some sort of "outline" developed for the Help section.
  4. There is a definite tension between "informing and educating new users" and "providing quick access for the experienced user.
    Maybe two different help sections ?--
    Help for the new user (I can see th Guidelines, Article Creation and General Help sections
    Help for the experienced user. (I can see the existing "Article Creation" section being left as is for the experienced user
  5. "Not part" means -- the Help page contains no pointer to necessary pages without a long, involved, and serendipitous quest. Missing is any kind of a "logical progression" for the new editor, or index so that an experienced editor can find things without having to guess what it is called for the search engine.
    Now to start modifying/integrating or creating pages (this page)...
  6. ... like writing documentation (class notes, etc.) for students --
    • What do you assume they know?
    • What do they need to know?
    • What should they need to know?
    • What do you write extensive, detailed instructions for?
    • What do you gloss over so that their eyes don't gloss over...
    • How do you accommodate differing levels of expertise?

Quest documentation

Parts of the Quest creation process

The Template should always transclude the matching Template/doc and Preload files, which should also always be transcluded into the Boilerplate page!

Working Pages (Quest)


Prototype (starter pages)

Documentation Project parts

Other pages to be integrated

  • Help -- main help page
  • Help:Introduction
  • User:Magill/Project-Documentation-Help-reformat -- done -- 26 September 2013

Ideas from User:Sethladan/Brainstorming

Documentation

I have been promising people a guide-to-mediawiki-markup thing for a while, and it's definitely a major hole in our support system for new (and experienced) editors. Hate doing this kind of thing from scratch but sooner begun is sooner done. Will tackle this following skills - will be nice to do wordsmithing instead of parameter-hunting.

Manual

"How can I do it?"

This "manual" will cover several pages. Also want to write more clear guidelines and a style guide, but those are separate from markup manual - dealing exclusively with technical how-to-do-it.

  • 100-level - foundational stuff everyone should know
    • Introduction / about wiki editing: Mostly plain text, describing the layout of the wiki, namespaces, how to edit, etc
    • Markup 101: Your basic formatting elements, subsections for links and basic tables probably
    • ?Using templates?: This warrants discussion, but not sure if it's better for manual or guidelines. WILL NOT cover how to write/edit templates, but just to call them and things-to-know. Also cover includes?
    • IRC? How to get on, how to register nick, commands for admins and all.
  • 200-level - dealing with specific topics in depth
    • Tables
    • Templates: this will probably require multiple pages and will heavily reference styles and rules-for-gud-riting
    • HTML? What works in MediaWiki, what doesn't. This might be a 100 level because lots of people try to use plain HTML when it just doesn't work, or they use outdated HTML that should be discouraged (that's a guideline/style issue, though.)
    • JavaScript? I'm not in a position to teach much of it, but it's worth mentioning at least to some extent how it works on the wiki and what are some of the larger processes going on (coords, tooltips, collapses)
    • CSS? Definitely at least need an explanation of the many classes available here, could also include editing one's own stylesheet.

Guidelines

"How must I do it?"

TBC

Manual of Style

"How should I do it?"

TBC

Wiki Markup


This page contains various notes, both for my own use and in preparation for compiling a more thorough guide to wiki editing on Lotro-Wiki. The information here may or may not make sense to anyone but me! No promises that anything will actually work as written.

Transclusion

  • noinclude: The content is displayed on the original page only but not transcluded to other pages.
  • includeonly: The content is not displayed on the original page, but is transcluded to other pages.
  • onlyinclude: This is the complicated one - if a page contains onlyinclude, then ONLY content within those tags is considered for transclusion (although multiple sets of onlyinclude will all be considered). Content inside onlyinclude will still appear on the main page.

Thus: noinclude and includeonly are mutually exclusive, while onlyinclude limits what can be transcluded.

Defining the Help Tree


Eleazaros comments From the Lorebook

I believe that a revamp of the on-line help is in order.

It should be focused towards 'users' of the site versus its current mix & match format, with a link to 'editors help' pages where information on how to edit THIS site is available (put the generic info there but have the help specific to THIS site).

User Help

The users portion should cover, in detail, how to browse through the site, review categories, use the category links on pages, how to best use the search capabilities, etc...

  • How to tell the difference between official and user provided information.
  • Searching the Site
  • Special Search considerations
  • European spellings in use.
  • Special character considerations (Udunion versus Udúnion) -- not all have 'you could mean' covered, such as my example here.
  • How to navigation via category links and other such 'built in' navigation tools.
  • How/where to report problems/errors.
NOTE: The Report a Bug link from the toolbox is wrong! It takes you to a bug report form and NOT to the lorebook bug forum. Until 'beta' is removed, this SHOULD link to the forum versus the bug report system.
  • Examples of what does NOT and what does qualify as a bug/bad info.
Missing page from following a link versus a 1h hammer listed as a 2h sword.
Not all the information on an item showing versus a Vendor NPC being listed as a Monster.
Etc.. These kinds of examples.
  • A detailed description on how to report missing/bad 'official' information.
  • How to report missing/bad user provided information.
  • How to tell what is a link -- if an image is a link or if it's just an image, internal versus external link appearances, etc...

These kinds of information should be covered in the user portion of the on-line help.

Editors Help

The editors portion should start by explaining how to categorize additions, it should show how to create a player/monster character page, how to create a kinship, proper categorization of PC/MC pages and kinships -- UNDER servers, etc...

Suggested areas of focus for editing:

  • Logging into the site so you can edit.
  • What templates are available and how to use them
  • How to use the Discussion tabs to discuss specific issues/concerns.
  • Basic MediaWiki markup information.
  • Basic HTML markup information.
  • Basic CSS information.
  • How to categorize pages properly.
  • Creation and use of a user Sandbox page.
  • Server information layouts (user server info).
  • Kinship/Tribe creation.
  • Player/Monster Character creation.
  • Appending information to 'official' pages.
  • Appending information to user submitted pages.
  • Special Headings
  • Spoiler Alerts
  • Walkthrough uses

Advanced Editors Help

Advanced editing would be about such things as:

  • (form style) Template creation
  • (parser style) Template creation
  • Development 'good practices'
  • Creation and use of a user Sandbox page.
  • Categorization of works in progress (Templates may need to be in the template namespace to be tested yet are not 'done' yet.)
  • Categorizing your works in progress as YOUR work in progress.
  • How to use the 'History' to view changes.
  • Special Headers -- how/when to use
  • Delete requests
  • Move requests
  • Stubs/SectStubbs
  • Cleanup Requests
  • Requested Projects by users
  • ToDo lists for development

Sumation

The help system is a bit abbreviated at this time and could use a revamp to provide better help for the users and those wishing to help contribute information to this site.

Mixing editing information with use information can be quite confusing to some that simply are looking for help on how to navigate this site and find things they know are, or should be, in the lorebook.

I've outlined a few ideas here that I have on the subject and I hope others might provide their thoughts on this subject here as well.

Eleazaros 01:32, 26 December 2007 (EST)

SOP: What is Patrolling" all about

SOP -- Procedural info for editors, i.e.

My understanding was that adding {{Welcome}} and patrolling would go hand-in-hand. Once editors have been around for a while and have been promoted, then their edits are automatically patrolled, but until then it basically serves as a way to make sure that changes made by new editors are actually valid changes and not vandalism. You would check through the unpatrolled edits and mark them patrolled if there were no problems. At the same time, if the edits were made by a completely new editor, you would add {{Welcome}} to their talk page and [[Category:Users]] to their user page. That way it all got taken care of and it was possible to give any pointers to people as they started rather than someone noticing a problem by chance after they had been doing something for months. There also used to be (not sure if its still the same) a lot of accounts created that never actually made any edits. I imagine that adding {{Welcome}} only when they actually start editing would help keep the wiki smaller, rather than having lots of extra pages (however small each is) that are never going to be visited. Amphoras (talk) 23:35, 1 August 2013 (EDT)

test a tool

{{Special:PrefixIndex/User:Magill/}}

Retrieved from "https://lotro-wiki.com/w/index.php?title=User:Magill/Project-Documentation&oldid=1479816"