User:Dneary

(New page: '''Staging ground for new main page''' <!-- ==== "Welcome to maEmo Wiki" and article count ======== --> {| style="width:400px; border:solid 0px; background:none;" |style="width:400px; te...)
m (Reverted edits by 190.63.196.4 (Talk) to last revision by dneary)
 
(17 intermediate revisions not shown)
Line 1: Line 1:
-
'''Staging ground for new main page'''
+
Hi, I'm Dave Neary, the maemo.org docsmaster. That means I'm at the service of the maemo.org community. My role is to help improve existing documentation, facilitate the community in situations where they need help getting infrastructure or information, and in general make myself useful.
-
<!-- ==== "Welcome to maEmo Wiki" and article count ======== -->
+
Here I host some drafts for content which will go "live" later.
-
{| style="width:400px; border:solid 0px; background:none;"
+
-
|style="width:400px; text-align:left; white-space:nowrap; color:#000;" |
+
-
<div style="font-size:200%; border:none; margin:0; color:#000;">Welcome to the [[maemo]] wiki.</div>
+
-
<div id="articlecount" style="width:100%; text-align:center; font-size:85%;">[[Special:Statistics|{{NUMBEROFARTICLES}}]] articles.</div>
+
-
|}
+
-
This wiki is to replace [http://maemo.org/community/wiki/ old one]. There is no registration form, just use your login information from [http://garage.maemo.org/ Garage].
+
== Documenting maemo.org ==
 +
A list of community processes that need better documentation:
-
<!-- quick ref -->
+
* [[Maemo.org team/Updating maemo.org sites | How does the live website get updated from maemo2midgard SVN?]]
-
<!--
+
* Where does the information for the user profile page come from in the Midgard database?
-
    All links added to a quick ref list should point to existing pages.
+
* Which pages in maemo.org have custom templates associated, and where are they in maemo2midgard SVN?
-
    For a quick reference to be useful, a page will usually be long. Since this
+
* In general, what is the process for publishing/displaying a Midgard page?
-
    page will never be long, I think that a quick reference of links isn't useful.
+
* Autobuilder documentation
-
-->
+
* extras-testing infrastructure documentation
-
<!--
+
* Web configuration (which directories can be touched, which cannot, and why)
-
{|style="width: 100%; margin:0; padding:0; border-collapse: collapse;"
+
* Servers and services, logins and roles
-
|style="width: 25%;"|
+
-
[[Help:Contents|Help]]<br/>
+
-
[[Help:About|About Us]]<br>
+
-
[[Help:About|About Us]]<br>
+
-
|style="width: 25%;"|
+
-
[http://en.wikipedia.org/wiki/How_to_edit_a_page#Wiki_markup Editing Help]<br/>
+
-
[http://meta.wikimedia.org/wiki/Help:TemplateWanted Templates Help]<br>
+
-
[[Help:About|About Us]]
+
-
|style="width: 25%;"|
+
-
[[Maemo_Linux_Wiki:Mailing List|Mailing List]]<br/>
+
-
[[Maemo Linux Wiki:Irc|IRC]]<br>
+
-
[[Help:About|About Us]]
+
-
|style="width: 25%;"|
+
-
[[FAQ_Who_are_the_admins|Admin Listing]]<br/>
+
-
[[News|News Listing]]<br>
+
-
[[Docs:Wanted|Articles Wanted!]]
+
-
|style="width: 25%;"|
+
-
|}
+
-
----
+
-
-->
+
-
{|style="margin:0px 0px 0px 0px; background:none;" width="100%"
+
== "Edit help" extension ==
-
|class="MainPageBG" style="border:1px solid #e2dbd2; background:#fff0df; vertical-align:top; color:#000;"|
+
-
{|width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#fff0df;"
+
-
! <div style="border: 1px solid #aea395; background:#ffd9ac; height: 52px; display: block; position: relative; padding: 0.1em 0.1em 0.1em 0.5em">[[Image:50px-Nuvola apps important yellow.svg.png|50px|right]]<h2 style="font-size: 120%; font-weight: bold; position: absolute; z-index: 10; border: none; text-decoration: none">Hot Topics</h2></div>
+
-
|-
+
-
|style="color:#000;"|
+
-
{{Hot Topics}}
+
-
|-
+
-
|}
+
-
|}
+
-
<!-- Top Tier Subject Selections -->
+
I created a very simple extension for Mediawiki to allow us to add a "help getting started in the wiki" text at the top of every editing page. Here are the instructions for installing it:
-
<!-- Community-->
+
1. Add the following line to LocalSettings.php:
-
 
+
require_once("$IP/extensions/EditHelp.php");
-
{|style="margin:0px 0px 0px 0px; background:none;"
+
2. Put the following in a file in mediawiki's extensions directory, in a file called EditHelp.php (we use the page hook [http://www.mediawiki.org/wiki/Manual:Hooks/EditPage::showEditForm:initial editFormTextTop] to insert the text into the page):
-
|class="MainPageBG category_block"|
+
<pre>
-
{|width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#fff0df;"
+
<?php
-
! <div class="category_header">[[Image:Maemo contact icon-fade.png|52px|right]]<h2 class="category_header_title">Community</h2></div>
+
if ( !defined( 'MEDIAWIKI' ) )
-
|-
+
        die ();
-
|style="color:#000;"|
+
-
{{Community}}
+
$wgHooks['EditPage::showEditForm:initial'][] = 'editHelp';
-
|-
+
-
|}
+
function editHelp($editPage) {
-
 
+
        global $wgOut;
-
<!-- Development -->
+
-
 
+
$editPage->editFormTextTop .= $wgOut->parse( '{{Edit help}}' );
-
|style="border:1px solid transparent"|
+
-
|class="MainPageBG category_block"|
+
        return true;
-
{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#fff0df;"
+
}
-
! <div class="category_header">[[Image:Maemo xterm icon-fade.png|52px|right]]<h2 style="font-size: 120%; font-weight: bold; position: absolute; z-index: 10; border: none; text-decoration: none">Development</h2></div>
+
</pre>
-
|-
+
3. Put the editing help instructions in a template called [[Template:Edit help]]
-
|style="color:#000;"|
+
-
{{Development}}
+
-
|-
+
-
|}
+
-
 
+
-
<!-- Troubleshooting -->
+
-
 
+
-
|style="border:1px solid transparent"|
+
-
|class="MainPageBG category_block"|
+
-
{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#fff0df;"
+
-
! <div class="category_header">[[Image:Maemo question icon-fade.png|52px|right]]<h2 style="font-size: 120%; font-weight: bold; position: absolute; z-index: 10; border: none; text-decoration: none">Troubleshooting</h2></div>
+
-
|-
+
-
|style="color:#000;"|
+
-
{{Troubleshooting}}
+
-
|-
+
-
|}
+
-
 
+
-
<!-- Tips & How Tos -->
+
-
 
+
-
|style="border:1px solid transparent"|
+
-
|class="MainPageBG category_block"|
+
-
{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; background:#fff0df;"
+
-
! <div class="category_header">[[Image:Maemo Info icon-fade.png|52px|right]]<h2 style="font-size: 120%; font-weight: bold; position: absolute; z-index: 10; border: none; text-decoration: none">Tips & How Tos</h2></div>
+
-
|-
+
-
|style="color:#000;"|
+
-
{{Tips & How Tos}}
+
-
|-
+
-
|}
+
-
|}
+
-
 
+
-
__NOEDITSECTION__ <!-- disables the [edit] links from being shown -->
+
-
__NOTOC__ <!-- disable the table of contents from ever being shown -->
+

Latest revision as of 20:33, 19 February 2017

Hi, I'm Dave Neary, the maemo.org docsmaster. That means I'm at the service of the maemo.org community. My role is to help improve existing documentation, facilitate the community in situations where they need help getting infrastructure or information, and in general make myself useful.

Here I host some drafts for content which will go "live" later.

[edit] Documenting maemo.org

A list of community processes that need better documentation:

  • How does the live website get updated from maemo2midgard SVN?
  • Where does the information for the user profile page come from in the Midgard database?
  • Which pages in maemo.org have custom templates associated, and where are they in maemo2midgard SVN?
  • In general, what is the process for publishing/displaying a Midgard page?
  • Autobuilder documentation
  • extras-testing infrastructure documentation
  • Web configuration (which directories can be touched, which cannot, and why)
  • Servers and services, logins and roles

[edit] "Edit help" extension

I created a very simple extension for Mediawiki to allow us to add a "help getting started in the wiki" text at the top of every editing page. Here are the instructions for installing it:

1. Add the following line to LocalSettings.php:

require_once("$IP/extensions/EditHelp.php");

2. Put the following in a file in mediawiki's extensions directory, in a file called EditHelp.php (we use the page hook editFormTextTop to insert the text into the page):

<?php
if ( !defined( 'MEDIAWIKI' ) )
        die ();
 
$wgHooks['EditPage::showEditForm:initial'][] = 'editHelp';
 
function editHelp($editPage) {
        global $wgOut;
 
	$editPage->editFormTextTop .= $wgOut->parse( '{{Edit help}}' );
 
        return true;
}

3. Put the editing help instructions in a template called Template:Edit help