Recent

Author Topic: Editing the Wiki pages  (Read 1795 times)

johnmc

  • New Member
  • *
  • Posts: 47
Editing the Wiki pages
« on: March 22, 2019, 02:53:13 pm »
I have been editing one or two of the wiki pages to see if I can improve them. Before I delve too deeply I have a few questions.

Do I need to make sure other languages are updated too?

What is the impact of changing the page tag "{{key down}}", is there a way of finding the pages that link to the one I want to change? e.g. I would like to change the page "key down" to "OnKeyDown" as that is the what is shown in the Object Inspector, and I don't really want to duplicate information that is already available.
I started with http://wiki.freepascal.org/LCL_Components and added a new section for the Form component from there you can link to TForm. I have added a list of properties and events as they are listed in the Object Inspector , as can be seen only a couple have links to existing pages I would like to find and link in others such as OnKeyDown.

John

Martin_fr

  • Administrator
  • Hero Member
  • *
  • Posts: 9754
  • Debugger - SynEdit - and more
    • wiki
Re: Editing the Wiki pages
« Reply #1 on: March 22, 2019, 03:49:12 pm »
Below the memo in which you edit the page, there is a link "Templates used on this page: " which you can unfold to see templates. Then go to the template you want to know about. In the menu on the left, find and click "What links here"

http://wiki.freepascal.org/Special:WhatLinksHere/Template:key_down

-----------------
I am not sure all of this needs to be (duplicated?) on the wiki: https://lazarus-ccr.sourceforge.io/docs/lcl/forms/tform.html

This is afaik (let someone confirm this) generated from the fpcocs that are also included in the lazarus  install.
So getting the latest of them, and supply patches for them, may be an approach too.
« Last Edit: March 22, 2019, 03:53:43 pm by Martin_fr »

dsiders

  • Hero Member
  • *****
  • Posts: 1045
Re: Editing the Wiki pages
« Reply #2 on: March 22, 2019, 05:19:15 pm »
I am not sure all of this needs to be (duplicated?) on the wiki: https://lazarus-ccr.sourceforge.io/docs/lcl/forms/tform.html

This is afaik (let someone confirm this) generated from the fpcocs that are also included in the lazarus install.
So getting the latest of them, and supply patches for them, may be an approach too.

+1 for updating the FPDoc files.

The page was generated using FPDoc XML files at some point. But we can't tell when because there's no version information on any of the pages. It would be useful if the page footers included version information.
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

lucamar

  • Hero Member
  • *****
  • Posts: 4219
Re: Editing the Wiki pages
« Reply #3 on: March 22, 2019, 05:51:28 pm »
I am not sure all of this needs to be (duplicated?) on the wiki: https://lazarus-ccr.sourceforge.io/docs/lcl/forms/tform.html

Indeed! For standard controls, properties, methods and events the wiki should serve to expand on and clarify the documentation as well as to procure examples of use, preferibly taken from real life applications. Simply duplicating the docs in the wiki is worst than lost effort: it's wasting effort that should have gone directly to the docs.

For example, those page on "key press/down"? Almost worthless as they are: There should be instead a page summing up and refining the information, including examples, about key event handling. Something like the page: LCL Key handling but from the application's point of view.

Fact is the wiki, in general, needs a serious, conscientious overhaul. All efforts are welcome, of course, but please: think before editing.
Turbo Pascal 3 CP/M - Amstrad PCW 8256 (512 KB !!!) :P
Lazarus/FPC 2.0.8/3.0.4 & 2.0.12/3.2.0 - 32/64 bits on:
(K|L|X)Ubuntu 12..18, Windows XP, 7, 10 and various DOSes.

Martin_fr

  • Administrator
  • Hero Member
  • *
  • Posts: 9754
  • Debugger - SynEdit - and more
    • wiki
Re: Editing the Wiki pages
« Reply #4 on: March 22, 2019, 06:06:40 pm »
Ok, seems the online help is ages old...

Btw, fpdoc has place for examples and all.

 

TinyPortal © 2005-2018