Difference between pages "Adding an Ebuild to the Wiki" and "Template:CreateAccount"

From Funtoo
(Difference between pages)
Jump to: navigation, search
(What We Have So Far)
 
 
Line 1: Line 1:
This page describes how to add an official entry for an ebuild to the Funtoo Linux wiki.
+
[http://auth.funtoo.org:9093/new Create a Funtoo account]
 
+
== Goal ==
+
 
+
Our goal for ebuild wiki pages is ambitious -- the wiki should have complete and excellent documentation for using every ebuild in Portage. If the ebuild exists in your Funtoo Linux Portage tree, and there is no corresponding ebuild page for it, you're encouraged to use these instructions to add a page to the wiki for it.
+
 
+
== What We Have So Far ==
+
 
+
To see what ebuild pages we have so far, see the [[Ebuilds by CatPkg]] page to see if the "CatPkg" (category/package atom) is already on this wiki.
+
 
+
You can also view all pages having to do with ebuilds (which also includes Package pages themselves) by going to the [[:Category:Ebuilds]] page. Package pages will be listed by their regular wiki page names, which may make them harder to find.
+
 
+
== The Package Namespace ==
+
 
+
This wiki has a special MediaWiki [http://www.mediawiki.org/wiki/Help:Namespaces namespace] called <code>Package</code>. Pages in this namespace have a URL that is prefixed with <code>Package:</code>, such as this wiki page: [[Package:Accelerated_AMD_Video_Drivers]], which is also a good example of a wiki page for an ebuild.
+
 
+
== An Example Ebuild Page ==
+
 
+
Let's look at an ebuild page: [[Package:Accelerated AMD Video Drivers]]. You'll notice it has a unique look that is distinct from a regular wiki page.
+
 
+
There are several other notable things about package pages. Let's take a look at each:
+
 
+
* As covered earlier, the ebuild is in the Package namespace.
+
* The ebuild is in the [[:Category:Ebuilds]] category.
+
* In the left-hand Tools menu, you can click <code>Browse Properties</code> on an Ebuild page to view its queryable semantic properties.
+
* There is an infobox in the upper-right corner that lists current ebuild maintainer, and the source repository to which it belongs, as well as its official CatPkg name.
+
 
+
And one of the most important things to note about this Ebuild page is the name of the wiki page itself. Rather than being named <code>x11-drivers/ati-drivers</code>, as the ebuild is identified in the Portage tree, it has a regular English name as the wiki page name. Some ebuilds, like the [[Package:Nginx]] page, have the regular package name as the wiki page name. The general rule for naming ebuild pages is that htey should be named as a regular wiki page, with a descriptive English name in the Package namespace. The Package namespace (as well as being part of the [[:Category:Ebuilds]] category) indicates that this page is about a Package (ebuild.)
+
 
+
== Semantic Data ==
+
 
+
The following semantic data is stored for each Package page:
+
 
+
* [[Property:CatPkg|CatPkg]] (string) - the canonical name (catpkg atom) for the package in its overlay or repository.
+
* [[Property:Maintainer|Maintainer]] (Page) - a link to the maintainer(s) of this package (if the user has a User page, it will link there.)
+
* [[Property:Repository|Repository]] (Page) - a link to the repository from which this ebuild is sourced. This can be an overlay or a full Portage tree.
+
* [[Property:Summary|Summary]] (Text) - a short summary, typically a sentence, that describes the functionality of the ebuild.
+
 
+
== Creating a Package Page ==
+
 
+
To add an Ebuild page to the wiki, use the widget below, which will pop up a form to guide you through the creation process. Remember the naming guidelines... If you were creating a wiki page for <code>www-servers/apache</code>, you would probably name the wiki page "Apache" or "Apache Web Server", and ''then'' enter <code>www-servers/apache</code> as the ''CatPkg'' on the form.
+
 
+
You will also be prompted for a Summary, Maintainer and a Repository. The Repository (as well as Maintainer) field will auto-complete, based on Users and Repositories defined on the wiki. If you don't know the right values for either of these, just leave them blank -- a staff member will fill them in properly for you. Our main goal is to get ''quality documentation'' online, so if you can help with that, fantastic!
+
 
+
{{#forminput:form=Ebuild|size=|default value=|button text=Add Package|autocomplete on namespace=Package|remote autocompletion|placeholder=Descriptive name|popup}}
+

Latest revision as of 05:10, 16 June 2014

Create a Funtoo account