راهنمای ویکی
رونما
این ویکی از صفحاتی ساخته شده که هر کدام شامل:
- یک مسیر
- یک عنوان
- یک محتوا
مسیرها ، صفحات یکتا را مشخص می کنند و همچنین URL دسترسی به آن را تعریف می کنند.
برای مثال ، برای دسترسی به یک صفحه با مسیر
lang/open/ باید به URL ای با آدرس
http://gambasdoc.org/help/lang/open رجوع کرد.
محتوا صفحات باید از نحو تشریح شده در بخش 'نحو ویکی' در پایین همین صفحه پیروی کند.
عنوان برای نمایش یک لینک به یک صفحه استفاده می شود و از نحو قبلی پیروی نمی کند.
در صورت پیوند به یک صفحه بدون موجودیت ، متن پیوند مسیر آن صفحه می باشد که به صورت کج نمایش داده می شود.
قراردادهای مسیر
مسیر صفحات به لحاظ تئوری آزاد می باشند ؛ اما باید از قوانین زیر پیروی شود:
- تمام صفحات مربوط به زبان ، برای لغات کلیدی و توابع باید در lang/ قرار بگیرند. همجنین مکان روانماها در cat/ می باشد.
- تمام صفحات مربوط به کامپوننت ها در comp/ قرار می گیرند. مسیر یک صفحه کامپوننت به صورت comp/gb.xxx/class/symbol/ می باشد.در صورتی که صفحه مربوط به یک رویداد کلاس باشد ، symbol با یک نقطه شروع می شود.
- تمام صفحات مربوط به واژه نامه باید در def/ باشند.
- اسناد متفرقه باید در مسیر /doc قرار گیرند.
چگونه یک صفحه موجود را ویرایش کنیم
بر روی لینک 'ویرایش' در بالای صفحه کلیک کنید.
یک پنجره محاوره ای نمایان می شود که شما باید در آن جا نام کاربری و کلمه عبور خود را وارد کنید.این پنجره محاوره ای تنها یکبار برای هر جلسه نمایان می شود.
سپس شما می توانید صفحه و عنوان آن را با پیروی از 'نحو ویکی' ویرایش کنید. عنوان صفحات کلاس ، متد ، رویداد و ثابت را تغییر ندهید ، آنها به صورت خودکار تولید می شوند.
کپی و ذخیره کردن محتوا اصلی پنجره ویرایش در یک ویرایشگر معمول مانند gedit (یا Notepad) می تواند خیلی مفید باشد.
بعد از ویرایش بر روی دکمه 'ذخیره' برای به هنگام آوری صفحه کلیک کنید.
چگونه یک صفحه جدید ایجاد کنیم
URL صفحه جدید را در مرورگر خود وارد کنید. سپس ویکی به شما می گوید که صفحه مورد نظر وجود ندارد و پیوند 'ساختن' را در بالای صفحه نمایش می دهد.بر روی این پیوند کلیک کنید تا صفحه مورد نظر ایجاد گردد.
چگونه یک صفحه را حذف کنیم
به بخش ویرایش صفحه رفته و عنوان و محتوا صفحه را حذف کنید.
چگونه یک صفحه را به زبان خودتان ترجمه کنید
تنها کافی است که صفحه را ویرایش کنید ، اما با مشاهده پرچم در سمت بالا - راست صفحه اطمینان حاصل کنید که در حال نمایش صفحه به زبان مقصد می باشید. اگر پرچم کشور شما در این لیست نمی باشد کافی است به من بگویید تا آن را اضافه کنم.
 |
تنها عنوان و محتوا صفحه را ترجمه کنید. پیوند و نام صفحه را ویرایش نکنید!
|
رشته های از پیش تعریف شده ویکی را چگونه ترجمه کنیم
رشته های از پیش تعریف شده ویکی مانند هر چیزی به جز محتوا و عنوان صفحه، در فایل ترجمه پروژه دست نوشته
CGI ای قرار دارد که ویکی را مدیریت می کند.
کد منبع این پروژه در بایگانی کد منبع
گامباس قرار دارد.نام این پروژه 'doc.cgi' می باشد. کافی است آن را مانند پروژه های دیگر ترجمه کنید.
(در 28 اکتبر 2006 و از نسخه gambas2-1.9.45 نرم افزار گامباس به همراه مدیر پایگاه داده و ویکی به فارسی ترجمه شد.)
صفحات تصویری
شما می توانید در ویکی تصاویر را بارگذاری کنید. یک تصویر صفحه ای می باشد که آخرین عنصر آن با یک دونقطه شروع می شود.
برای مثال control
:combobox تصویری است که یک کنترل جعبه ترکیب (combo-box) را نمایش می دهد.
برای درج یک تصویر داخل یک صفحه عادی ، تنها کافی است به آن پیوند بدهید ؛ برای مثال
control/:combobox/
نحو ویکی
در اینجا رونمایی کلی که شما باید برای نوشتن مقالات ویکی ازآن استفاده بکنید ، مشاهده می شود.
نویسه های قالب بندی
|
نحو
|
توضیحات
|
نتیجه
|
|
*Bold*
|
درج متن به صورت توپر
|
Bold
|
|
/Italic/
|
درج متن به صورت کج
|
Italic
|
|
=TypeWriter=
|
استفاده از یک قلم نامتناسب
|
TypeWriter
|
|
_Underline_
|
درج متن با خط زیر
|
Underline
|
 |
اگر بعد از یک نویسه ، فاصله درج گردد ، نویسه به عنوان یک نویسه قالب بندی شروعی تفسیر نمی شود. همچنین اگر قبل از یک نویسه ، فاصله درج گردد ، نویسه به عنوان یک نویسه قالب بندی پایانی تفسیر نمی شود.
/ *Gambas* =Already= _Means_ BASIC! /
چاپ می کند
/ Gambas Already Means BASIC! /
و نه
Gambas Already Means BASIC!
|
 |
نشانه های HTML (زبان نشانه گذاری ابرمتن) باقی می مانند.آنها توسط ویکی تفسیر نمی شود.
|
اگر وارد کنید ...
|
شما دریافت می کنید...
|
|
M<sup>rs</sup> <font color="red">Pierce</font>
|
Mrs Pierce
|
|
 |
اگر می خواهید از نویسه های ویژه به صورت عادی استفاده کنید ، یا اگر می خواهید نشانه های HTML درج نشوند ، باید قبل از آنها از نویسه فرار ممیز وارونه (backslash) استفاده کنید.
|
اگر وارد کنید ...
|
شما دریافت می کنید...
|
|
\*Bold\*
|
*Bold*
|
|
Don't do \<\<that>>!
|
Don't do <<that>>!
|
|
عنوان ها ، پاراگراف ها و خطوط
برای رفتن به یک خط جدید در نتیجه نهایی ، برای مثال شروع یک پاراگراف جدید ، باید یک خط خالی درج کنید.
Example
|
اگر وارد کنید ...
|
شما دریافت می کنید...
|
|
Gambas Already
Means BASIC!
|
Gambas Already Means BASIC!
|
|
Gambas Already
Means BASIC!
|
Gambas Already
Means BASIC!
|
درصورتی که خط را با یک خط تیره زیرین به پایان برسانید ، آنگاه یک شکننده خط درج می شود.
Example
|
اگر وارد کنید ...
|
شما دریافت می کنید...
|
|
Gambas Already_
Means BASIC!
|
Gambas Already
Means BASIC!
|
 |
شما می توانید از نویسه های ویژه زیر تنها در شروع خطوط استفاده کنید.
|
|
نحو
|
توضیحات
|
نتیجه
|
+Title
|
نمایش عنوان بزرگ
|
Title
|
++Title
|
نمایش عنوان کوچکتر
|
Title
|
+++Title
|
و همچنین ...
|
Title
|
++++Title
|
|
Title
|
|
--
|
خط افقی
|
|
==
<u>This is *verbatim* text</u>
==
|
متن تحت الفظی. توجه کنید که نشانه های HTML تفسیر می شوند.
|
|
جداول
شما می توانید از نویسه های ویژه زیر تنها در شروع خط استفاده کنید.
|
نحو
|
توضیحات
|
|
[[
|
شروع یک جدول
|
|
]]
|
پایان یک جدول
|
|
][
|
جدا کننده دو سطر
|
|
-
|
جدا کننده دو ستون
|
اولین سطر همیشه سرآیند (header) می باشد . اگر سطر اول خالی باشد ، آنگاه سرآیند نمایش داده نمی شود.
Example
|
اگر وارد کنید ...
|
شما دریافت می کنید...
|
اگر وارد کنید ...
|
شما دریافت می کنید...
|
[[
First header
-
Second header
-
Third header
][
1
-
2
-
3
][
4
-
5
-
6
]]
|
|
First header
|
Second header
|
Third header
|
|
1
|
2
|
3
|
|
4
|
5
|
6
|
|
[[
][
1
-
2
-
3
][
4
-
5
-
6
]]
|
|
پیوند ها
این ویکی دارای قابلیت پیوند خودکار (autolink) می باشد. تنها راه برای غیرفعال کردن آن استفاده از نویسه فرار ممیز وارونه می باشد.
|
نحو
|
توضیحات
|
نتیجه
|
|
[/lang/arithop]
|
پیوند به یک مبحث
|
عملگرهاي رياضي
|
|
[http://gambas.sourceforge.net|Gambas web site]
|
پیوند به URL
|
Gambas web site
|
|
What is ASCII ?
|
پیوند خودکار
|
What is ASCII ?
|
|
What is \ASCII ?
|
نحوه غیرفعال سازی پیوند خودکار
|
What is ASCII ?
|
 |
در صورت شروع شدن نام یک صفحه با یک نویسه '@' ، آن صفحه به عنوان پیوندی نمادی به یک صفحه حقیقی که نشانی آن ، باقی عنوان صفحه می باشد در نظر گرفته می شود. این صفحه را ویرایش کنید تا این موضوع را متوجه شوید.
|
بخش های ویژه
یک بخش با خطی که در آن نویسه '{' درج شده شروع و با خطی با نویسه '}' به پایان می رسد.
بخش ها می توانند به صورت تو در تو باشند.
|
اگر وارد کنید ...
|
شما دریافت می کنید...
|
{syntax
This is the syntax of a function
}
|
This is the syntax of a function
|
{example
Example
}
|
مثال
|
{seealso
See also these functions...
}
|
همچنین مشاهده کنید
See also these functions...
|
{box
Just a box
}
|
Just a box
|
{warning
Warning!
}
|
 |
Warning!
|
|
{info
Note that point.
}
|
 |
Note that point.
|
|
{vb
Visual Basic does not work like \Gambas.
}
|
 |
Visual Basic does not work like Gambas.
|
|
{tip
A tip may help you.
}
|
 |
A tip may help you.
|
|
- قبل و بعد از هر بخش یک شکننده خط (خط خالی) قرار دهید
- داخل بخش seealso شکننده خط قرار ندهید.
دستورات ویژه
یک دستور ویژه با یک نویسه '@' شروع می شود.
|
Special command
|
Description
|
|
@components
|
لیست تمام کامپوننت ها را درج می کند
|
|
@classes
|
لیست تمام کلاس های کامپوننت جاری را درج می کند.
|
|
@symbols
|
لیست تمام نمادهای کلاس جاری را درج می کند.
|
|
@index /root/index/path
|
نمایه تمام صفحات مسیر ریشه مشخص شده را می سازد. تنها سطح اول نمایه گذاری می شود.
|