157 from the rest of the text in which it appears. |
156 from the rest of the text in which it appears. |
158 |
157 |
159 == Links == |
158 == Links == |
160 |
159 |
161 Links are central to the wiki principle, as they create the web of |
160 Links are central to the wiki principle, as they create the web of |
162 content. Google Code wiki permits both internal (within the wiki) and |
161 content. The HWKB wiki permits both internal (within the wiki) and |
163 external links, and in some cases automatically creates a link when it |
162 external links, and in some cases automatically creates a link when it |
164 recognizes either a !WikiWord or an URL. |
163 recognizes either a !WikiWord or an URL. |
165 |
164 |
166 === Internal wiki links === |
165 === Internal wiki links === |
167 |
166 |
237 |
236 |
238 You can of course link to external pages from your own wiki pages, |
237 You can of course link to external pages from your own wiki pages, |
239 using a syntax similar to that for internal links: |
238 using a syntax similar to that for internal links: |
240 |
239 |
241 {{{ |
240 {{{ |
242 Plain URLs such as http://www.google.com/ or ftp://ftp.kernel.org/ are |
241 Plain URLs such as https://www.example.org/ automatically made into links. |
243 automatically made into links. |
|
244 |
242 |
245 You can also provide some descriptive text. For example, the following |
243 You can also provide some descriptive text. For example, the following |
246 link points to the [http://www.google.com Google home page]. |
244 link points to the [https://www.example.org Example homepage]. |
247 |
245 |
248 If your link points to an image, it will get inserted as an image tag |
246 If your link points to an image, it will get inserted as an image tag |
249 into the page: |
247 into the page: |
250 |
248 |
251 http://code.google.com/images/code_sm.png |
249 https://www.hedgewars.org/images/Static_Hat_Template.png |
252 |
250 |
253 You can also make the image into a link, by setting the image URL as |
251 You can also make the image into a link, by setting the image URL as |
254 the description of the URL you want to link: |
252 the description of the URL you want to link: |
255 |
253 |
256 [http://code.google.com/ http://code.google.com/images/code_sm.png] |
254 [https://www.hedgewars.org/ https://www.hedgewars.org/images/Static_Hat_Template.png] |
257 }}} |
255 }}} |
258 |
256 |
259 Plain URLs such as http://www.google.com/ or ftp://ftp.kernel.org/ are |
257 Plain URLs such as https://www.example.org/ automatically made into links. |
260 automatically made into links. |
|
261 |
258 |
262 You can also provide some descriptive text. For example, the following |
259 You can also provide some descriptive text. For example, the following |
263 link points to the [http://www.google.com Google home page]. |
260 link points to the [https://www.example.org Example homepage]. |
|
261 |
|
262 If your link points to an image, it will get inserted as an image tag |
|
263 into the page: |
|
264 |
|
265 https://www.hedgewars.org/images/Static_Hat_Template.png |
264 |
266 |
265 You can also make the image into a link, by setting the image URL as |
267 You can also make the image into a link, by setting the image URL as |
266 the description of the URL you want to link: |
268 the description of the URL you want to link: |
267 |
269 |
268 {{{ |
270 {{{ |
269 [http://code.google.com/ http://code.google.com/images/code_sm.png] |
271 [https://www.hedgewars.org/ https://www.hedgewars.org/images/Static_Hat_Template.png] |
270 }}} |
272 }}} |
271 |
273 |
272 [http://code.google.com/ http://code.google.com/images/code_sm.png] |
274 [https://www.hedgewars.org/ https://www.hedgewars.org/images/Static_Hat_Template.png] |
273 |
|
274 |
275 |
275 === Links to images === |
276 === Links to images === |
276 |
277 |
277 If your link points to an image (that is, if it ends in `.png`, |
278 If your link points to an image (that is, if it ends in `.png`, |
278 `.gif`, `.jpg` or `.jpeg`), it will get inserted as an image into the |
279 `.gif`, `.jpg` or `.jpeg`), it will get inserted as an image into the |
279 page: |
280 page: |
280 |
281 |
281 {{{ |
282 {{{ |
282 http://code.google.com/images/code_sm.png |
283 https://www.hedgewars.org/images/Static_Hat_Template.png |
283 }}} |
284 }}} |
284 |
285 |
285 http://code.google.com/images/code_sm.png |
286 https://www.hedgewars.org/images/Static_Hat_Template.png |
286 |
287 |
287 If the image is produced by a server-side script, you may need to add a nonsense query string parameter to the end so that the URL ends with a supported image filename extension. |
288 If the image is produced by a server-side script, you may need to add a nonsense query string parameter to the end so that the URL ends with a supported image filename extension. |
288 |
289 |
289 {{{ |
290 {{{ |
290 http://chart.apis.google.com/chart?chs=200x125&chd=t:48.14,33.79,19.77|83.18,18.73,12.04&cht=bvg&nonsense=something_that_ends_with.png |
291 http://chart.apis.google.com/chart?chs=200x125&chd=t:48.14,33.79,19.77|83.18,18.73,12.04&cht=bvg&nonsense=something_that_ends_with.png |
396 <wiki:comment> |
397 <wiki:comment> |
397 This text will be removed from the rendered page. |
398 This text will be removed from the rendered page. |
398 </wiki:comment> |
399 </wiki:comment> |
399 }}} |
400 }}} |
400 |
401 |
401 = +1 Button = |
|
402 |
|
403 Use `<g:plusone></g:plusone>` to add a [http://www.google.com/+1/button/ +1 button] to the page. Example: |
|
404 |
|
405 {{{ |
|
406 <g:plusone size="medium"></g:plusone> |
|
407 }}} |
|
408 |
|
409 <g:plusone size="medium"></g:plusone> |
|
410 |
|
411 The count, size, and href parameters are supported; see http://code.google.com/apis/+1button/ for documentation. |
|
412 |
|
413 = Gadgets = |
|
414 |
|
415 You can embed [http://www.google.com/ig/directory?synd=open Gadgets] on your wiki pages with the following syntax: |
|
416 |
|
417 {{{ |
|
418 <wiki:gadget url="http://example.com/gadget.xml" height="200" border="0" /> |
|
419 }}} |
|
420 |
|
421 Valid attributes are: |
|
422 * `url`: the URL of the gadget |
|
423 * `width`: the width of the gadget |
|
424 * `height`: the height of the gadget |
|
425 * `title`: a title to display above the gadget |
|
426 * `border`: "0" or "1", whether to draw a border around the gadget |
|
427 * `up_*`: Gadget user preference parameters |
|
428 * `caja`: "0" or "1", whether to use Caja to render the gadget. [http://code.google.com/p/google-caja Caja] helps protect users from malicious or accidental errors in third party gadgets. |
|
429 |
|
430 WorkingWithGoogleGadgets describes how to create gadgets for Google Code. It also provides a few helpful suggestions that can make it easier to publish gadgets and to integrate with other Google products such as iGoogle. |
|
431 |
|
432 InterestingDeveloperGadgets shows some sample gadgets you may want to include on your project pages. |
|
433 |
|
434 = Videos = |
|
435 |
|
436 You can embed videos with the following syntax: |
|
437 |
|
438 {{{ |
|
439 <wiki:video url="http://www.youtube.com/watch?v=3LkNlTNHZzE"/> |
|
440 }}} |
|
441 |
|
442 Valid attributes are: |
|
443 * `url`: the URL of the video |
|
444 * `width`: the width of the embedded video |
|
445 * `height`: the height of the embedded video |
|
446 |
|
447 Right now we support videos from YouTube,. Other video sites may be embeddable via a gadget, as described above. |
|
448 |
402 |
449 = Navigation = |
403 = Navigation = |
450 == Table of Contents == |
404 == Table of Contents == |
451 |
405 |
452 An inline table of contents can be generated from page headers on a wiki page. Add the following syntax to a page in the location the table of contents should be displayed: |
406 An inline table of contents can be generated from page headers on a wiki page. Add the following syntax to a page in the location the table of contents should be displayed: |
458 Valid attributes are: |
412 Valid attributes are: |
459 * `max_depth`: the maximum header depth to display in the table of contents |
413 * `max_depth`: the maximum header depth to display in the table of contents |
460 |
414 |
461 == Side navigation == |
415 == Side navigation == |
462 |
416 |
463 You can specify the sidebar for a wiki page by selecting another wiki page that defines your side navigation. The [http://code.google.com/p/guava-libraries/wiki/GuavaExplained?tm=6 Guava project] uses the sidebar extensively across its wiki. |
417 You can specify the sidebar for a wiki page by selecting another wiki page that defines your side navigation. |
464 |
418 |
465 One way of adding a sidebar is by setting the #sidebar pragma, as shown below. Alternatively, the sidebar pragma can be left blank if no side navigation is desired. |
419 One way of adding a sidebar is by setting the #sidebar pragma, as shown below. Alternatively, the sidebar pragma can be left blank if no side navigation is desired. |
466 |
420 |
467 || #sidebar !TableOfContents || |
421 || #sidebar !TableOfContents || |
468 |
422 |
477 * [DOMReference DOM reference] |
431 * [DOMReference DOM reference] |
478 * [HTMLElements HTML reference] |
432 * [HTMLElements HTML reference] |
479 * [CSSReference CSS reference] |
433 * [CSSReference CSS reference] |
480 }}} |
434 }}} |
481 |
435 |
482 A default sidebar page can also be specified for all wiki pages by project owners through the Wiki settings in the Administer tab. If a #sidebar pragma is also specified, it will take precedence on the page. |
436 --- |
483 |
437 |
484 = Localizing Wiki Content = |
438 _The content on this page is based on the old Google Code documentation for Google Code wikis and has been adapted and changed to fit the HWKB. The original document by Google is licensed under the [http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution 3.0 License]. User-generated content is not included in this license._ |
485 |
|
486 Along with the default language for the wiki, which can be set through the Wiki settings in the Administer tab, additional languages are also supported. If more than one language is available, based on a user's language preference (e.g. browser language), the wiki will try to serve the page for the appropriate language. If no wiki page exists for that language, it will fall back to the default language. Comments, however, are shared amongst all translations of a wiki page. |
|
487 |
|
488 New translations for a page cannot be added through the web interface and have to be added through the Subversion repository. |
|
489 |
|
490 To add a translation of a page, first checkout the wiki from Subversion: <br/> |
|
491 `svn checkout https://`<b>yourproject</b>`.googlecode.com/svn/wiki/` <b>yourdirectory</b> `-username` <b>yourusername</b> |
|
492 |
|
493 Then create a new directory under /wiki/ using the two letter ISO-639 code as the name of that directory. Place all translated files in the new directory and submit those changes to the Subversion repository. |
|
494 |
|
495 The following is an example of a valid wiki directory: |
|
496 {{{ |
|
497 wiki/ |
|
498 ja/ |
|
499 ProjectHistory.wiki |
|
500 StyleGuide.wiki |
|
501 zh-Hans/ |
|
502 ProjectHistory.wiki |
|
503 StyleGuide.wiki |
|
504 zh-Hant/ |
|
505 ProjectHistory.wiki |
|
506 StyleGuide.wiki |
|
507 ProjectHistory.wiki |
|
508 StyleGuide.wiki |
|
509 }}} |
|
510 |
|
511 Once the files have been submitted to the project's subversion repository, they can now be edited through the wiki's web editor. The process is the same for Mercurial or Git projects, except that the wiki lives in the root directory (not wiki/) of `https://wiki.`<b>yourproject</b>`.googlecode.com/hg/` or `https://wiki.`<b>yourproject</b>`.googlecode.com/git/`. |
|
512 |
|
513 Note: The wiki accepts a subset of ISO-639 two letter language codes, where a few of the codes (such as zh_Hans) contain locale-specific codes. Such locale-specific codes should use a hyphen (zh-Hans) separator. A few example language codes have been specified in the table below. |
|
514 |
|
515 <table border=1> |
|
516 <tbody><tr> |
|
517 <th style="padding: 4px 4px 4px 8px;" scope="col"> Language (Locale)</th> |
|
518 <th style="padding: 4px 4px 4px 8px;" scope="col"> Directory Name |
|
519 </th> |
|
520 </tr> |
|
521 <tr> |
|
522 <td>Arabic</td> |
|
523 <td>ar</td> |
|
524 </tr> |
|
525 <tr> |
|
526 <td>Bulgarian</td> |
|
527 <td>bg</td> |
|
528 </tr> |
|
529 <tr> |
|
530 <td>Chinese (China)</td> |
|
531 <td>zh-Hans</td> |
|
532 </tr> |
|
533 <tr> |
|
534 <td>Chinese (Taiwan)</td> |
|
535 <td>zh-Hant</td> |
|
536 </tr> |
|
537 <tr> |
|
538 <td>Croatian</td> |
|
539 <td>hr</td> |
|
540 </tr> |
|
541 <tr> |
|
542 <td>Czech</td> |
|
543 <td>cs</td> |
|
544 </tr> |
|
545 <tr> |
|
546 <td>Danish</td> |
|
547 <td>da</td> |
|
548 </tr> |
|
549 <tr> |
|
550 <td>Dutch</td> |
|
551 <td>nl</td> |
|
552 </tr> |
|
553 <tr> |
|
554 <td>English (United Kingdom)</td> |
|
555 <td>en-GB</td> |
|
556 </tr> |
|
557 <tr> |
|
558 <td>English (United States)</td> |
|
559 <td>en-US</td> |
|
560 </tr> |
|
561 <tr> |
|
562 <td>Finnish</td> |
|
563 <td>fi</td> |
|
564 </tr> |
|
565 <tr> |
|
566 <td>French</td> |
|
567 <td>fr</td> |
|
568 </tr> |
|
569 <tr> |
|
570 <td>German</td> |
|
571 <td>de</td> |
|
572 </tr> |
|
573 <tr> |
|
574 <td>Greek</td> |
|
575 <td>el</td> |
|
576 </tr> |
|
577 <tr> |
|
578 <td>Hebrew</td> |
|
579 <td>he</td> |
|
580 </tr> |
|
581 <tr> |
|
582 <td>Hungarian</td> |
|
583 <td>hu</td> |
|
584 </tr> |
|
585 <tr> |
|
586 <td>Italian</td> |
|
587 <td>it</td> |
|
588 </tr> |
|
589 <tr> |
|
590 <td>Japanese</td> |
|
591 <td>ja</td> |
|
592 </tr> |
|
593 <tr> |
|
594 <td>Korean</td> |
|
595 <td>ko</td> |
|
596 </tr> |
|
597 <tr> |
|
598 <td>Norwegian</td> |
|
599 <td>no</td> |
|
600 </tr> |
|
601 <tr> |
|
602 <td>Polish</td> |
|
603 <td>pl</td> |
|
604 </tr> |
|
605 <tr> |
|
606 <td>Portuguese (Brazil)</td> |
|
607 <td>pt-BR</td> |
|
608 </tr> |
|
609 <tr> |
|
610 <td>Romanian</td> |
|
611 <td>ro</td> |
|
612 </tr> |
|
613 <tr> |
|
614 <td>Russian</td> |
|
615 <td>ru</td> |
|
616 </tr> |
|
617 <tr> |
|
618 <td>Slovak</td> |
|
619 <td>sk</td> |
|
620 </tr> |
|
621 <tr> |
|
622 <td>Spanish</td> |
|
623 <td>es</td> |
|
624 </tr> |
|
625 <tr> |
|
626 <td>Swedish</td> |
|
627 <td>sv</td> |
|
628 </tr> |
|
629 <tr> |
|
630 <td>Turkish</td> |
|
631 <td>tr</td> |
|
632 </tr> |
|
633 </tbody></table> |
|
634 |
|
635 _The content on this page created by Google is licensed under the [http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution 3.0 License]. User-generated content is not included in this license._ |
|