Difference between revisions of "Help talk:Funtoo Editing Guidelines"

From Funtoo
Jump to: navigation, search
m (add toc because this page is quickly becoming a mess, add console output example, move disqus to bottom of the page due to slow rendering from disqus)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__TOC__
+
[[Requested_Documents]] <<---- we should revive this!  let the people request page updates in a centralized location.  we probably need to get the army ants going on the samba page.  rtl entropy is borked.
  
== console output ==
+
<comment-streams/>
there are no examples of console output.
 
  
<pre>
+
=== Fancy Boxes ===
<console>###i## some command
 
output
 
output
 
</console>
 
</pre>
 
 
 
produces
 
 
 
<console>###i## some command
 
output
 
output
 
</console>
 
 
 
== Seo friendly spaces ==
 
it should be noted that google indexes seo_unfriendly_url as seounfriendlyurl while it indexes seo-friendly-url as seo and friendly and url keywords.  thus we should prefer - instead of _ for spaces.
 
 
 
http://www.funtoo.org/Web-server-stack <--- good
 
 
 
http://www.funtoo.org/Funtoo_Linux_Installation <--- bad
 
 
 
see http://youtu.be/_CbNXj3YlK4
 
 
 
== Fancy Boxes ==
 
 
TODO: Describe fancy* boxes, and explain the most fool-proof way of using them. Use this format, exactly:
 
TODO: Describe fancy* boxes, and explain the most fool-proof way of using them. Use this format, exactly:
  
Line 35: Line 11:
  
 
Cool!
 
Cool!
 +
}}
  
 +
=== watching pages ===
 +
we should have a section dedicated to explaining how to watch pages that an editor is knowledgeable about, and how to use the watch list to keep the pages clean, concise, and accurate.
 +
ie if i know about the web server stack i watch that, and pages related to that...  (i think i might need to turn off watching pages i touch automatically...)
  
}}
+
To watch, or unwatch a page:
 
+
in the menu bar {{c|Actions > Watch}} or {{c|Actions > Unwatch}}
  
== ebuild documentation ==
+
To display the watchlist:
 +
in the menu bar {{c|account > watchlist}}
  
http://www.funtoo.org/Adding_an_Ebuild_to_the_Wiki
+
To adjust watchlist settings:
 +
(this should probably have a better default setting guide or wiki section detailing better settings for default watchlist settings....  though i can see the virtue in what it is set at out of the box.)
 +
;[[Special:Preferences#mw-prefsection-watchlist]]
  
i think the first part should have a link to adding the build wiki info.  the pages should be linked against each other.  & or transclusion at the bottom of this help article.  (and a very minor note that the file stuff should be bundled into the fancy notes at the bottom.) =D  <3 u guys
+
rss codes should be also generated to easily track the watch list so everyone gets pinged when a change occurs[[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 03:55, March 27, 2015 (UTC)
  
== Special Characters ==
+
=== Special Characters ===
  
 
To produce pipes: <pre>{{!}}</pre>
 
To produce pipes: <pre>{{!}}</pre>
 
generates: {{!}}
 
generates: {{!}}
  
(i think equals needs a similar template?)
+
To produce equals: <pre>{{=}}</pre>
 
+
generates: {{=}}
{{fancynote|That's right {{=}} I added it}}
 
  
Note that in general cases you can use the <code><nowiki><nowiki></nowiki></code> markup that displays inner content as-is, but for a single character that might have lots of occurrences that's quite a pain.
+
=== delete template ===
 
 
== delete template ==
 
 
to flag a page as a candidate for deletion, insert
 
to flag a page as a candidate for deletion, insert
 
<pre>{{delete}}</pre>
 
<pre>{{delete}}</pre>
Line 65: Line 45:
 
[[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 16:54, 20 September 2014 (UTC)
 
[[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 16:54, 20 September 2014 (UTC)
  
== Minor edits ? ==
+
=== Minor edits ===
 +
Check minor edits to note that your commit is a small commit.  A minor edit can be filtered out of logs when searching through them.
 +
 
 +
=== video playlists ===
 +
i have several examples of how to embed playlists in [[Programming]] but there are no examples in how to wiki.
 +
 
 +
=== links ===
 +
fixing a broken link brought this subject to my attention.
 +
[www.link.com is this a bug?] && [link.com shouldn't this work?] do not work...  brackets or not.
 +
 
 +
no protocol defined external links <nowiki>[//test.com //test.com]</nowiki> produces (use these style links)
 +
[//test.com //test.com]
  
Should we use the checkbox "This is a minor edit" and when should we use it ? I often forget to set this option when I make what I consider a "minor edit", but what is the purpose? Is it somehow useful? -- [[User:Pytony|Pytony]] ([[User talk:Pytony|talk]])
+
no bracket links:
: http://www.funtoo.org/index.php?title=Special:RecentChanges&hideminor=1 <--- you can hide minor changes...  like duncans recent flooding of the logs with category changes on templates should all be minor changes, if not double tisk ;-) [[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 22:41, 26 September 2014 (UTC)
+
http://google.com
 +
(regardless that this service only offers https)
  
::Oh that's right, thanks. Maybe this could be good to add in the page, dear BDFL :P -- [[User:Pytony|Pytony]] ([[User talk:Pytony|talk]])
+
=== Image Embedding ===
:::I really think we need a section explaining NOT to edit for W to w or category changes ONLY....  this is really a shortcoming in mediawiki not detecting "stub edits" and moving them out of the primary logs.  this morning looking at the changes i see all these tiny commits, with out content being rolled in also.  in all reality minor edits is poorly designed in the base web app and should be bug reported upstream.  it should be include minor edits, rather than exclude minor edits.....  [[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 01:28, 4 October 2014 (UTC)
+
To embed images:
 +
<pre>[[File:Nginx.gif|class=img-responsive|center]]</pre>
 +
[[File:Nginx.gif|class=img-responsive|center]]
  
== how to talk pages ==
+
=== how to talk pages ===
  
 
we need a section explaining how to indent for step2 of talk threads
 
we need a section explaining how to indent for step2 of talk threads
Line 83: Line 77:
 
we need a note about user talk pages being a messaging system....  (i put a disqus on my talk page so i get email notifications when people say things to me) [[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 22:41, 26 September 2014 (UTC)
 
we need a note about user talk pages being a messaging system....  (i put a disqus on my talk page so i get email notifications when people say things to me) [[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 22:41, 26 September 2014 (UTC)
  
== template requests ==
+
=== template requests ===
=== external resources ===
+
==== external resources ====
 
I would like a sexy little widget for by the top of the page with links to: tldp, wikipedia, ohloh, cvedetails, github, sourceforge, etc with sexy little icons.  It will make our pages feel more interwoven with the larger linux community. ;-) [[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 23:30, 2 October 2014 (UTC)
 
I would like a sexy little widget for by the top of the page with links to: tldp, wikipedia, ohloh, cvedetails, github, sourceforge, etc with sexy little icons.  It will make our pages feel more interwoven with the larger linux community. ;-) [[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 23:30, 2 October 2014 (UTC)
  
 
http://www.cvedetails.com/vendor/12010/Mariadb.html
 
http://www.cvedetails.com/vendor/12010/Mariadb.html
  
=== fortune of the day ===
+
==== fortune of the day ====
 
I'd like a daily fortune rotation on my user page to show im looney tunes ;-) [[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 23:30, 2 October 2014 (UTC)
 
I'd like a daily fortune rotation on my user page to show im looney tunes ;-) [[User:Threesixes|Threesixes]] ([[User talk:Threesixes|talk]]) 23:30, 2 October 2014 (UTC)
  
== chat ==
+
=== widget requests ===
{{DISQUS}}
+
# http://www.mediawikiwidgets.org/Widget:Ohloh_Project for dynamic language summary on packages
 +
# http://www.mediawikiwidgets.org/Alexa <-this ones pretty rad
 +
# http://www.mediawikiwidgets.org/AddThis
 +
# adsense, the sites set for traffic, corporate sponsorship is a good idea.  https://www.mediawiki.org/wiki/Extension:Google_AdSense_2

Latest revision as of 00:19, November 4, 2020

Requested_Documents <<---- we should revive this! let the people request page updates in a centralized location. we probably need to get the army ants going on the samba page. rtl entropy is borked.

<comment-streams/>

Fancy Boxes

TODO: Describe fancy* boxes, and explain the most fool-proof way of using them. Use this format, exactly:

   Important

Now you can put lots of funky stuff in here, like html tags, etc, and not have a problem with the parameter getting passed as the first parameter.

Cool!

watching pages

we should have a section dedicated to explaining how to watch pages that an editor is knowledgeable about, and how to use the watch list to keep the pages clean, concise, and accurate. ie if i know about the web server stack i watch that, and pages related to that... (i think i might need to turn off watching pages i touch automatically...)

To watch, or unwatch a page: in the menu bar Actions > Watch or Actions > Unwatch

To display the watchlist: in the menu bar account > watchlist

To adjust watchlist settings: (this should probably have a better default setting guide or wiki section detailing better settings for default watchlist settings.... though i can see the virtue in what it is set at out of the box.)

Special:Preferences#mw-prefsection-watchlist

rss codes should be also generated to easily track the watch list so everyone gets pinged when a change occurs. Threesixes (talk) 03:55, March 27, 2015 (UTC)

Special Characters

To produce pipes:

{{!}}

generates: |

To produce equals:

{{=}}

generates: =

delete template

to flag a page as a candidate for deletion, insert

{{delete}}

at the top of a page.

   Warning

This page has been proposed for deletion because it does not meet the Editing Guidelines.
If you disagree, please discuss it here.

Threesixes (talk) 16:54, 20 September 2014 (UTC)

Minor edits

Check minor edits to note that your commit is a small commit. A minor edit can be filtered out of logs when searching through them.

video playlists

i have several examples of how to embed playlists in Programming but there are no examples in how to wiki.

links

fixing a broken link brought this subject to my attention. [www.link.com is this a bug?] && [link.com shouldn't this work?] do not work... brackets or not.

no protocol defined external links [//test.com //test.com] produces (use these style links) //test.com

no bracket links: http://google.com (regardless that this service only offers https)

Image Embedding

To embed images:

[[File:Nginx.gif|class=img-responsive|center]]
Nginx.gif

how to talk pages

we need a section explaining how to indent for step2 of talk threads

ie conversation 2
ie convo 3
we need info on using tilde's to sign and date etc... noting that its good practice to sign with 4 ~
   Tip
~~~ && ~~~~ && ~~~~~
produces Threesixes (talk) && Threesixes (talk) 22:41, 26 September 2014 (UTC) && 22:41, 26 September 2014 (UTC)

we need a note about user talk pages being a messaging system.... (i put a disqus on my talk page so i get email notifications when people say things to me) Threesixes (talk) 22:41, 26 September 2014 (UTC)

template requests

external resources

I would like a sexy little widget for by the top of the page with links to: tldp, wikipedia, ohloh, cvedetails, github, sourceforge, etc with sexy little icons. It will make our pages feel more interwoven with the larger linux community. ;-) Threesixes (talk) 23:30, 2 October 2014 (UTC)

http://www.cvedetails.com/vendor/12010/Mariadb.html

fortune of the day

I'd like a daily fortune rotation on my user page to show im looney tunes ;-) Threesixes (talk) 23:30, 2 October 2014 (UTC)

widget requests

  1. http://www.mediawikiwidgets.org/Widget:Ohloh_Project for dynamic language summary on packages
  2. http://www.mediawikiwidgets.org/Alexa <-this ones pretty rad
  3. http://www.mediawikiwidgets.org/AddThis
  4. adsense, the sites set for traffic, corporate sponsorship is a good idea. https://www.mediawiki.org/wiki/Extension:Google_AdSense_2