mozilla

Compare Revisions

Quick start

Change Revisions

Revision 526419:

Revision 526419 by jswisher on

Revision 526439:

Revision 526439 by jswisher on

Title:
Quick start
Quick start
Slug:
MDN/Quick_start
MDN/Quick_start
Content:

Revision 526419
Revision 526439
n66      <li>Converting code samples to be "live"n66      <li>
67        <a href="/en-US/docs/Project:MDN/Contributing/How_to/Conv
 >ert_code_samples_to_be_live_">Convert code samples to be "live"</
 >a>
n69    <table class="full-width-table">n
70      <tbody>
71        <tr>
72          <td>
73            <strong>What is the task?</strong>
74          </td>
75          <td>
76            MDN now has a "live sample" system, where the code sa
>mple shown on a page is directly used to display the output of th 
>at same&nbsp; sample. However, many existing articles have code s 
>amples that do not yet use this system. 
77          </td>
78        </tr>
79        <tr>
80          <td>
81            <strong>What do you need to know to do the task?</str
>ong> 
82          </td>
83          <td>
84            <ul>
85              <li>Understanding of HTML, CSS and/or JavaScript, d
>epending on the code sample. 
86              </li>
87              <li>Ability to use <a href="/en-US/docs/Project:Int
>roduction_to_KumaScript">KumaScript</a> macros within MDN article 
>s. 
88              </li>
89            </ul>
90          </td>
91        </tr>
92        <tr>
93          <td>
94            <strong>What are the steps to do the task?</strong>
95          </td>
96          <td>
97            <p>
98              For a complete description of the live sample syste
>m, including how to create live samples, see <a href="/en-US/docs 
>/Project:MDN/Contributing/Editor_guide/Live_samples">Using the li 
>ve sample system</a>. 
99            </p>
100            <ol>
101              <li>Pick an article from the list of articles that 
>are tagged <a href="/en-US/docs/tag/NeedsLiveSample">NeedsLiveSam 
>ple</a>, where the code sample is for a feature you feel familiar 
> with. 
102              </li>
103              <li>Convert the code sample to be "live".
104              </li>
105              <li>Delete whatever code or image was previously us
>ed to display the output of the sample. 
106              </li>
107            </ol>
108            <p>
109              &nbsp;
110            </p>
111          </td>
112        </tr>
113        <tr>
114          <td>
115            <strong>Where does it need to be done?</strong>
116          </td>
117          <td>
118            Articles tagged <a href="/en-US/docs/tag/NeedsLiveSam
>ple">NeedsLiveSample</a> 
119          </td>
120        </tr>
121      </tbody>
122    </table>
tt79    <ul>
132    <h4 id="Tagging_JavaScript">80      <li id="Tagging_JavaScript">
133      Tagging JavaScript81        <a href="/en-US/docs/Project:MDN/Contributing/How_to/Tag_
 >JavaScript_pages">Tag JavaScript pages</a>
82      </li>
134    </h4>83    </ul>
135    <table class="fullwidth-table">
136      <tbody>
137        <tr>
138          <td>
139            <strong>What is the task?</strong>
140          </td>
141          <td>
142            <strong>Tagging</strong> consists in adding meta-info
>rmation to page so that related content can be grouped, like in t 
>he search tool. 
143          </td>
144        </tr>
145        <tr>
146          <td>
147            <strong>What do you need to know to do the task?</str
>ong> 
148          </td>
149          <td>
150            <ul>
151              <li>Basic JavaScript coding knowledge, like knowing
> what is a method or a property. 
152              </li>
153            </ul>
154          </td>
155        </tr>
156        <tr>
157          <td>
158            <strong>What are the steps to do it?</strong>
159          </td>
160          <td>
161            <ol>
162              <li>Go to the list of <a href="/en-US/docs/Web/Java
>Script/Doc_status#No_tags">JavaScript-related pages without tags< 
>/a>. 
163              </li>
164              <li>Choose one of the page.
165              </li>
166              <li>Click on the article link to load the page.
167              </li>
168              <li>Once the page has loaded, click on the <code>ED
>IT</code> button near its top; this puts you into the MDN editor. 
169              </li>
170              <li>At least the tag "<strong>JavaScript</strong>" 
>should be added. For methods belonging to an object it the name o 
>f the Object should be added (e.g. String.fromCharCode should hav 
>e "<strong>String</strong>"). Methods should have "<strong>Method 
></strong>" and properties need a "<strong>Property</strong>" tag. 
> Features added in a new ECMAScript version have a "<strong>ECMAS 
>cript6</strong>" plus "<strong>Experimental</strong>". All protot 
>otype methods have the "<strong>prototype</strong>" tag. Deprecat 
>ed and obsolete features have the same named tags. If pages need  
>any type of work, a "<strong>Need*</strong>" tag should be added 
171              </li>
172              <li>Save with a comment.
173              </li>
174              <li>You're done!
175              </li>
176            </ol>
177          </td>
178        </tr>
179        <tr>
180          <td>
181            <strong>Where does it need to be done?</strong>
182          </td>
183          <td>
184            Within specific articles that are marked as requiring
> tagging. 
185          </td>
186        </tr>
187      </tbody>
188    </table>

Back to History