AllLangHelp_swriter.mk | 1 source/auxiliary/swriter.tree | 1 source/text/shared/guide/start_parameters.xhp | 3 - source/text/swriter/guide/markdown.xhp | 69 ++++++++++++++++++++++++++ 4 files changed, 73 insertions(+), 1 deletion(-)
New commits: commit 9b8ae1606b540a82503d572b75a560149eeb206c Author: Olivier Hallot <[email protected]> AuthorDate: Mon Dec 15 20:39:58 2025 -0300 Commit: Olivier Hallot <[email protected]> CommitDate: Tue Dec 16 12:49:46 2025 +0100 Add markdown help page for Writer Change-Id: I2ae4a80c03b2a1ec03aa5f80a8ee02bcdc6f37ee Reviewed-on: https://gerrit.libreoffice.org/c/help/+/195688 Tested-by: Jenkins Reviewed-by: Olivier Hallot <[email protected]> diff --git a/AllLangHelp_swriter.mk b/AllLangHelp_swriter.mk index d8f088de23..c86885f3f7 100644 --- a/AllLangHelp_swriter.mk +++ b/AllLangHelp_swriter.mk @@ -343,6 +343,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,swriter,\ helpcontent2/source/text/swriter/guide/keyboard \ helpcontent2/source/text/swriter/guide/load_styles \ helpcontent2/source/text/swriter/guide/main \ + helpcontent2/source/text/swriter/guide/markdown \ helpcontent2/source/text/swriter/guide/navigator \ helpcontent2/source/text/swriter/guide/nonprintable_text \ helpcontent2/source/text/swriter/guide/number_date_conv \ diff --git a/source/auxiliary/swriter.tree b/source/auxiliary/swriter.tree index 8e421a290e..ecd2584f10 100644 --- a/source/auxiliary/swriter.tree +++ b/source/auxiliary/swriter.tree @@ -213,6 +213,7 @@ </node> <node id="0219" title="Loading, Saving, Importing, Exporting and Redacting"> <topic id="swriter/text/swriter/guide/send2html.xhp">Saving Text Documents in HTML Format</topic> + <topic id="swriter/text/swriter/guide/markdown.xhp">Working with Text Documents in Markdown Format</topic> <topic id="swriter/text/swriter/guide/textdoc_inframe.xhp">Inserting an Entire Text Document</topic> <topic id="shared/text/shared/guide/redaction.xhp">Redacting a Text Document</topic> <topic id="shared/text/shared/guide/auto_redact.xhp">Automatic Redaction</topic> diff --git a/source/text/shared/guide/start_parameters.xhp b/source/text/shared/guide/start_parameters.xhp index a3853ceb10..1e8cede198 100644 --- a/source/text/shared/guide/start_parameters.xhp +++ b/source/text/shared/guide/start_parameters.xhp @@ -211,8 +211,8 @@ <paragraph role="tablecontent" id="par_id315053o">Forces an input filter type, if possible. For example:</paragraph> <paragraph role="tablecontent" id="par_id411550934641187" localize="false"><input>--infilter="Calc Office Open XML"</input></paragraph> <paragraph role="tablecontent" id="par_id501550934647297" localize="false"><input>--infilter="Text (encoded):UTF8,LF,Liberation Mono,en-US"</input>.</paragraph> + <paragraph role="tablecontent" id="par_id261765835214157" localize="false"><input>--infilter='Markdown:{"TemplateURL":{"type":"string","value":"./template.ott"}}' test.md</input> </paragraph> <embed href="text/shared/guide/start_parameters.xhp#seefilters"/> - </tablecell> </tablerow> <tablerow> @@ -542,6 +542,7 @@ <paragraph role="tablecontent" id="par_id311550932952863" localize="false"><input>--convert-to pdf:writer_pdf_Export --outdir /home/user *.doc</input></paragraph> <paragraph role="tablecontent" id="par_id231550932985601" localize="false"><input>--convert-to "html:XHTML Writer File:UTF8" *.doc</input></paragraph> <paragraph role="tablecontent" id="par_id211550932999288" localize="false"><input>--convert-to "txt:Text (encoded):UTF8" *.doc</input></paragraph> + </section> <section id="seefilters"> <paragraph role="tablecontent" id="par_id781554408625219">See the <link href="text/shared/guide/convertfilters.xhp">list of document filters</link> for file conversion.</paragraph> diff --git a/source/text/swriter/guide/markdown.xhp b/source/text/swriter/guide/markdown.xhp new file mode 100644 index 0000000000..653a23b077 --- /dev/null +++ b/source/text/swriter/guide/markdown.xhp @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + --> + +<meta> + <topic id="text/swriter/guide/markdown.xhp" indexer="include" status="PUBLISH"> + <title id="tit">Markdown</title> + <filename>/text/swriter/guide/markdown.xhp</filename> + </topic> +</meta> +<body> +<bookmark id="bm_id421765831033457" branch="hid/CHANGE ME" localize="false"/> +<bookmark branch="index" id="bm_id641765835594010"> + <bookmark_value>markdown;file</bookmark_value> + <bookmark_value>file;markdown format</bookmark_value> + <bookmark_value>markdown;paste format</bookmark_value> +</bookmark> +<section id="markdown"> + <h1 id="hd_id581765831033457"><variable id="h1"><link href="text/swriter/guide/markdown.xhp">Working with markdown (.md) files</link></variable></h1> + <description id="par_id241765831033457">%PRODUCTNAME Writer can open and save files in markdown (.md) file format, as well as paste markdown contents in a text document.</description> +</section> +<paragraph role="paragraph" id="par_id41765833052175">Markdown is a lightweight markup language that allows you to format text using simple syntax. It is widely used for writing documentation, README files, forum posts, and even some emails.</paragraph> +<h2 id="hd_id31765836500832">Opening a markdown file</h2> +<list type="ordered"> + <listitem><paragraph id="par_idN10897" role="listitem">Choose <menuitem>File - Open</menuitem>.</paragraph></listitem> + <listitem> + <paragraph id="par_idN1089F" role="listitem">Locate the markdown file that you want to open.</paragraph> + <paragraph id="par_idN108A2" role="listitem">If the file has a *.md extension, select the file.</paragraph> + <paragraph id="par_idN108A5" role="listitem">If the markdown file has another extension, select the file, and then select "Markdown Document (.md, .markdown)" in the <emph>File type</emph> box</paragraph></listitem> + <listitem><paragraph id="par_idN1082D" role="listitem">Click <menuitem>Open</menuitem>.</paragraph></listitem> +</list> +<h2 id="hd_id401765836659571">To save a file in Markdown format</h2> +<list type="ordered"> +<listitem> +<paragraph id="par_idN10901" role="listitem">Open the text document that you want to save as a Markdown file.</paragraph> +</listitem> +<listitem> +<paragraph id="par_idN10905" role="listitem">Choose <menuitem>File - Save as</menuitem>.</paragraph> +</listitem> +<listitem> +<paragraph id="par_idN10915" role="listitem">In the <menuitem>File name</menuitem> box, enter a name for the file.</paragraph> +</listitem> +<listitem> +<paragraph id="par_idN1090D" role="listitem">In the <menuitem>File type</menuitem> box, select "Markdown Document (.md)".</paragraph> +</listitem> +<listitem> +<paragraph id="par_idN107FC" role="listitem">Click <menuitem>Save</menuitem>.</paragraph> +</listitem> +</list> +<h2 id="hd_id861765837133232">Pasting markdown contents in a %PRODUCTNAME text document.</h2> +<paragraph role="paragraph" id="par_id661765839151050">You can paste Markdown content directly into a %PRODUCTNAME Writer document. Writer intelligently applies the corresponding styles, automatically assigning paragraph, list, and character formatting, using the automatic (default) styles.</paragraph> +<tip id="par_id271765841051407">You can import styles from a custom template to customize the automatic styles.</tip> +<h2 id="hd_id951765840480116">Opening a markdown file using the command line</h2> +<paragraph role="paragraph" id="par_id471765840552211">You can open a Markdown file from the command line and automatically apply a template to generate a custom-formatted text document. Enter the following command in your operating system’s command shell to apply the template file <literal>template.ott</literal> to the file <literal>test.md</literal>:</paragraph> +<paragraph role="tablecontent" id="par_id261765835214157" localize="false"><input>soffice --infilter='Markdown:{"TemplateURL":{"type":"string","value":"./template.ott"}}' test.md</input></paragraph> +<tip id="par_id241765840493828">%PRODUCTNAME implements the <link href="https://commonmark.org/help/";>CommonMark</link> markdown specification.</tip> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id111765839422628"><link href="https://commonmark.org/";>CommonMark website</link></paragraph> +</section> + +</body> +</helpdocument>
