Oleg "Rowaa[SR13]" V. Volkov (rowaasr13) wrote in lj_userdoc,
Oleg "Rowaa[SR13]" V. Volkov

Constants for FAQ titles

I think I posted something like this before, but recently I composed longish entry for suggestions and I wish to repost it there. It was not accepted to suggestions because, as maintainer told me, "this is already being discussed with doc admins" and I should contact them. Well, to me this is the most direct method I could think of. :)

Constants that would hold FAQ titles for FAQ editing/translation system

Short, concise description of the idea
FAQ editing/translation system should have way to reference other FAQ titles without actually spelling them.

Full description of the idea
Many FAQs have links to other FAQ entries with their names and with introduction of HTML markup inside FAQ entries and usage of <a title="FAQ #N: FAQ Name" ...> there's even more places with those links. When FAQ name is changed, editor have to scan all other entries and replace all occurences - unnecessary work that also generates diffs for every translation. It is even worser problem in translations themselves - not only they get lots of diffs for changes that may actually not apply to them, but they also have to do those sweeps every time they translate or change entry, killing severity indication in progress or postponing change until everything else is taken care of. It would be much easier for translators and editors and would eliminate all of those problems if editor/translator just could write something like <a href="lj://faq/123" title="$LJ_FAQ_TITLE123">.

An ordered list of benefits

  • No extra work on each title change.
  • No extra diffs.
  • No worries of keeping list of "to do" list when you can't update other entries with new name because of non-zero severity when you change name or complete translation for translator.

An ordered list of problems/issues involved
  • None except implementation time.

An organized list, or a few short paragraphs detailing suggestions for implementation
  • Variables similar to used in S2 will do. $LJ_FAQ_TITLENNN looks good to me.

  • Post a new comment


    Comments allowed for members only

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded