Hello, for some time now I notice that help writers keep using embedvars to simplify their work. These not only make help unreadable for localizers (and thus prone to errors in localization), but introduce errors, as the use of embedvars in sentences is not allowed for languages with cases (like Slavic languages).
I urge online help writers not to use embedvars, even if that means some more spelling out of function and command names. Also, please do include this warning to any wiki or other documentation for future help contributors, *in bold*. I collected a list of all errors I have found so far (it refers to master as of October 15). My list is based on an assumption (which might not be correct) that it is OK when an embedded link is used standalone, as in /helpcontent2/source/text/sbasic/shared.po: #. LDkTk msgid "<embedvar href=\"text/sbasic/shared/03/sf_timer.xhp#TimerService\"/>" But the assumption might be wrong for some languages and even mine, since we are not aware what the referenced string spells out like – this form requires nominative case, but maybe the original string is not in nominative form ... There are plenty of those strings as well, sometimes appearing as the last sentence in a help file string, as a reference at the end of the help content paragraph. The list includes several occurrences where embedvars are either at the start or end of the string, but do not use a space before/after the rest of the strings (I added the red comment note to those). Whoever will be fixing these errors in master, please contact the original authors of the erroneous strings to warn them about these errors, so they stop doing it. Lp, m. *** */helpcontent2/source/text/sbasic/shared/03.po* #. YwSXj#: lib_ScriptForge.xhpmsgctxt """lib_ScriptForge.xhp\n""par_id1001623412767893\n""help.text"msgid "To learn more about how to create and execute Python scripts using the <literal>ScriptForge</literal> library, read the <embedvar href=\"text/sbasic/shared/03/sf_intro.xhp#title\"/> help page." #. ZzngK#: sf_intro.xhpmsgctxt """sf_intro.xhp\n""par_id31623411828158\n""help.text"msgid "Visit <embedvar href=\"text/sbasic/python/main0000.xhp#pythonscriptshelp\"/> for more information on Python scripting using %PRODUCTNAME." #. CHr5n#: sf_session.xhpmsgctxt """sf_session.xhp\n""par_id751626817335715\n""help.text"msgid "Read the help page <embedvar href=\"text/sbasic/python/python_locations.xhp#pythonlocations1\"/> to learn more about where Python scripts can be stored." */helpcontent2/source/text/sbasic/shared.po*#. CWMJG#: 03030303.xhpmsgctxt """03030303.xhp\n""par_id491610993401822\n""help.text"msgid "The <literal>Timer</literal> function measures time in seconds. To measure time in milliseconds use the <embedvar href=\"text/sbasic/shared/03/sf_timer.xhp#TimerService\"/>." #. Yy5Eh#: 03120102.xhpmsgctxt """03120102.xhp\n""par_id111552916434071\n""help.text"msgid "<embedvar href=\"text/sbasic/shared/00000003.xhp#err6\"/>, when VBA compatibility mode is enabled and expression is greater than 255." */helpcontent2/source/text/scalc/01.po*#. 2Ditv#: func_numbervalue.xhpmsgctxt """func_numbervalue.xhp\n""par_id351625601754290\n""help.text"msgid "Refer to the <embedvar href=\"text/shared/01/05020300.xhp#NumbersLink\"/> help page to learn how to change the format of numbers in a cell." */helpcontent2/source/text/scalc/guide.po*#. FrQEr#: numbers_text.xhpmsgctxt """numbers_text.xhp\n""par_id111567772433803\n""help.text"msgid "The text to number conversion can be customized in the <embedvar href=\"text/shared/optionen/detailedcalculation.xhp#detailed_heading\" markup=\"ignore\"/> option." #. XvTTj#: remove_duplicates.xhpmsgctxt """remove_duplicates.xhp\n""par_id31630021517873\n""help.text"msgid "Go to <menuitem>Data - More Filters - Standard Filter</menuitem>. This opens the <embedvar href=\"text/shared/02/12090100.xhp#StandardFilter_h1\"/> dialog." #. dzAEu#: table_cellmerge.xhpmsgctxt """table_cellmerge.xhp\n""par_id3154020\n""help.text"msgid "Or, choose <embedvar href=\"text/scalc/01/05060000.xhp#format_mergecells_menu\"/><menuitem>Merge Cells</menuitem>" #. DbZBM#: table_cellmerge.xhpmsgctxt """table_cellmerge.xhp\n""par_id6424146\n""help.text"msgid "Or, choose <embedvar href=\"text/scalc/01/05060000.xhp#format_mergecells_menu\"/><menuitem>Merge and Center Cells</menuitem>" #. zBdRG#: table_cellmerge.xhpmsgctxt """table_cellmerge.xhp\n""par_id9493087\n""help.text"msgid "Or, choose <embedvar href=\"text/scalc/01/05060000.xhp#format_mergecells_menu\"/><menuitem>Unmerge Cells</menuitem>." #. YC7sa#: table_cellmerge.xhpmsgctxt """table_cellmerge.xhp\n""par_id561632820960500\n""help.text"msgid "Or, toggle <embedvar href=\"text/scalc/01/05060000.xhp#format_mergecells_menu\"/><menuitem>Merge and Center Cells</menuitem>" */helpcontent2/source/text/scalc.po*#. tdJRk#: main0200.xhpmsgctxt """main0200.xhp\n""par_id3148798\n""help.text"msgid "This submenu lists the toolbars that are available in spreadsheets.<embedvar href=\"text/shared/00/00000007.xhp#symbolleistenneu\"/>"Comment: No space needed? Is the embedded string in 1st case? */helpcontent2/source/text/shared/01.po*#. VPwsL#: 05030500.xhpmsgctxt """05030500.xhp\n""par_id181630450040456\n""help.text"msgid "Read the help page <embedvar href=\"text/scalc/guide/borders.xhp#borders\"/> to learn more on how to define custom line arrangements." #. cdt69#: 05070200.xhpmsgctxt """05070200.xhp\n""par_id3144336\n""help.text"msgid "The vertical position of the selected objects is not affected by this command.<embedvar href=\"text/shared/01/05070100.xhp#mehrfachselektion\"/>"Comment: no space needed? Is the embedded strin in 1st case? #. fqg3X#: 05230100.xhpmsgctxt """05230100.xhp\n""par_id591602522244128\n""help.text"msgid "<embedvar href=\"text/shared/01/05230100.xhp#AdaptNote\"/> <menuitem>Format - Text</menuitem>." #. 3vHeN#: 06040000.xhpmsgctxt """06040000.xhp\n""par_id791632159942582\n""help.text"msgid "To turn off AutoCorrect in %PRODUCTNAME Writer choose <menuitem>Tools - AutoCorrect - While Typing</menuitem>. Refer to the help page <embedvar href=\"text/swriter/guide/auto_off.xhp#auto_off\"/> to learn more about deactivating AutoCorrect in %PRODUCTNAME Writer." #. cqbQV#: 06040000.xhpmsgctxt """06040000.xhp\n""par_id911632159367467\n""help.text"msgid "To turn off AutoCorrect in %PRODUCTNAME Calc, go to <menuitem>Tools - AutoCorrect Options</menuitem> and uncheck all items in the <emph>Options</emph> and <emph>Localized Options</emph> tabs. Refer to the help page <embedvar href=\"text/scalc/guide/auto_off.xhp#auto_off\"/> to learn more about deactivating AutoCorrect in %PRODUCTNAME Calc." */helpcontent2/source/text/shared/explorer/database.po*#. 6vbRr #: rep_main.xhp msgctxt "" "rep_main.xhp\n" "par_id2531815\n" "help.text" msgid "The <embedvar href=\"text/shared/explorer/database/rep_insertfield.xhp#addfields\" markup=\"ignore\"/> window opens automatically and shows all fields of the selected table." #. 9hPaG #: rep_prop.xhp msgctxt "" "rep_prop.xhp\n" "par_id3587145\n" "help.text" msgid "<ahelp hid=\".\">The <embedvar href=\"text/shared/explorer/database/rep_insertfield.xhp#addfields\" markup=\"ignore\"/> window is shown automatically when you have selected a table in the Contents box and leave that box. You can also click the Add Field icon on the toolbar, or choose <item type=\"menuitem\">View - Add Field</item>.</ahelp>" */helpcontent2/source/text/shared/guide.po*#. FepzD #: protection.xhp msgctxt "" "protection.xhp\n" "par_id761632164002322\n" "help.text" msgid "It is possible to use OpenPGP to define private and public keys to be used to encrypt %PRODUCTNAME documents. Read <embedvar href=\"text/shared/guide/openpgp.xhp#openpgph1\"/> to learn more on how to set up OpenPGP encryption keys." #. XCt7P #: redlining_accept.xhp msgctxt "" "redlining_accept.xhp\n" "par_id3147008\n" "help.text" msgid "If you have put multiple copies of the document in circulation, first merge these into one document (see <embedvar href=\"text/shared/guide/redlining_docmerge.xhp#redlining_docmerge\"/>)." */helpcontent2/source/text/shared/optionen.po*#. vYV69 #: 01070400.xhp msgctxt "" "01070400.xhp\n" "par_id3147229\n" "help.text" msgid "See also <embedvar href=\"text/shared/guide/print_blackwhite.xhp#print_blackwhite\"/>." #. XLNWu #: detailedcalculation.xhp msgctxt "" "detailedcalculation.xhp\n" "par_id3067110\n" "help.text" msgid "<emph>Convert only if unambiguous:</emph> If the text represents a valid and unambiguous numeric value, convert it. Example: <item type=\"input\">\"123.456\"</item> will generate a #VALUE! error because the text contains a separator, while <item type=\"input\">\"123456\"</item> will not.<br/>See <embedvar href=\"text/scalc/guide/numbers_text.xhp#numbers_text\" markup=\"ignore\"/> for details." */helpcontent2/source/text/simpress/01.po*#. WE2nx #: 05170000.xhp msgctxt "" "05170000.xhp\n" "par_id3159205\n" "help.text" msgid "<ahelp hid=\".uno:NewRouting\">Resets the line skew values to the default.</ahelp><embedvar href=\"text/shared/00/00000001.xhp#kontext\"/>" */helpcontent2/source/text/swriter/02.po*#. 7h49d #: 06140000.xhp msgctxt "" "06140000.xhp\n" "par_id261616371203225\n" "help.text" msgid "To restart numbering with a number greater than 1, right-click in the paragraph where you want to restart numbering, choose <menuitem>Paragraph - Paragraph - </menuitem><embedvar href=\"text/swriter/01/05030800.xhp#outlinelisth1\"/> tab, select <menuitem>Restart numbering at this paragraph</menuitem> and enter the start number in <menuitem>Start with</menuitem>." */helpcontent2/source/text/swriter/guide.po*#. 2YWVV #: load_styles.xhp msgctxt "" "load_styles.xhp\n" "par_id441529889103330\n" "help.text" msgid "<embedvar href=\"text/swriter/00/stylesmenu.xhp#sms\" markup=\"keep\"/> to open the <emph>Styles</emph> sidebar deck." #. PG4ys #: numbering_lines.xhp msgctxt "" "numbering_lines.xhp\n" "par_id3153960\n" "help.text" msgid "Format - Paragraph - <embedvar href=\"text/swriter/01/05030800.xhp#outlinelisth1\"/>" #. QEp87 #: using_numbering.xhp msgctxt "" "using_numbering.xhp\n" "par_id31616154131555\n" "help.text" msgid "If you want numbered headings, use <menuitem>Tools - </menuitem><embedvar href=\"text/swriter/01/06060000.xhp#ChapNumh1\"/>, instead of numbering manually." */helpcontent2/source/text/swriter.po*#. Vus62 #: main0215.xhp msgctxt "" "main0215.xhp\n" "par_id3147419\n" "help.text" msgid "<embedvar href=\"text/swriter/01/05060200.xhp#keinumlauftext\"/>You can also choose this setting on the <emph>Wrap</emph> tab page."Comment: no space needed? #. cqLEM #: main0215.xhp msgctxt "" "main0215.xhp\n" "par_id3153405\n" "help.text" msgid "<embedvar href=\"text/swriter/01/05060200.xhp#seitenumlauftext\"/>This icon represents the <emph>Page Wrap</emph> option on the <emph>Wrap</emph> tab page."Comment: no space needed? #. FMaCU #: main0215.xhp msgctxt "" "main0215.xhp\n" "par_id3147799\n" "help.text" msgid "<embedvar href=\"text/swriter/01/05060200.xhp#durchlauftext\"/>You can also define this setting on the <emph>Wrap</emph> tab page."Comment: no space needed? -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
