90 lines
3.4 KiB
Plaintext
90 lines
3.4 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2022, The Funkwhale Collective
|
|
# This file is distributed under the same license as the funkwhale package.
|
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: funkwhale 1.2.7\n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2022-07-23 12:18+0200\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
|
|
#: ../../documentation/restructured.rst:2
|
|
msgid "Writing reStructuredText"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:4
|
|
msgid "Funkwhale's documentation is written using a standard markup language called `reStructuredText <http://docutils.sourceforge.net/rst.html>`_. It is similar to Markdown and other web-based markup languages, but is better suited to technical documentation due to its standardized nature. A full syntax breakdown can be found `here <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html>`_, but the following should be enough to get you started on writing docs for Funkwhale."
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:11
|
|
msgid "Headings"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:13
|
|
msgid "Headings are useful for splitting up text into relevant subsections. With `Sphinx <http://www.sphinx-doc.org/>`_, major headers and direct subheaders are rendered as navigation links on Index pages, which makes them ideal for sharing specific information quickly."
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:17
|
|
msgid "Headers are written like so:"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:32
|
|
msgid "Underlines should be **at least** as long as the words they underline"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:35
|
|
msgid "Links"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:37
|
|
msgid "Links can be rendered in several different ways depending on where they link to:"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:45
|
|
msgid "Inline references can also be generated using the following syntax:"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:56
|
|
msgid "Lists"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:58
|
|
msgid "Bullet point lists are usually written using dashes like so:"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:67
|
|
msgid "Blocks"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:69
|
|
msgid "Blocks can be used to easily and concisely present information to a reader and are particularly useful when demonstrating technical steps. Blocks in reStructuredText can be written as follows:"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:87
|
|
msgid "Other syntax highlighting is available. See the spec for full details."
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:91
|
|
msgid "Content within code blocks should be indented by three spaces. You can end the code block by removing the indent."
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:95
|
|
msgid "Notes and Warnings"
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:97
|
|
msgid "Notes are great for presenting important information to users and providing additional context. Warnings can be very useful if a step you're writing about could potentially have adverse consequences."
|
|
msgstr ""
|
|
|
|
#: ../../documentation/restructured.rst:112
|
|
msgid "Content within notes and warnings should be indented by three spaces. You can end the block by removing the indent."
|
|
msgstr ""
|