|
|
|
@@ -62,57 +62,54 @@ If you are interested in becoming a contributor, you can [[path:user/register|re
|
|
|
|
#* In cases in which a change is directly related to an external document or policy, it may be helpful to mention the impetus in the log message. For example, documentation changes made to satisfy Eiffel Software problem reports should reference the report in the log message.
|
|
|
|
#* In cases in which a change is directly related to an external document or policy, it may be helpful to mention the impetus in the log message. For example, documentation changes made to satisfy Eiffel Software problem reports should reference the report in the log message.
|
|
|
|
# '''Renaming pages or moving pages to Trash:''' Before you rename a page or move it to the Trash, you should use the '''References''' tab to make certain that there are no current references to the page. If there are, make sure you resolve those references before renaming or moving the page.
|
|
|
|
# '''Renaming pages or moving pages to Trash:''' Before you rename a page or move it to the Trash, you should use the '''References''' tab to make certain that there are no current references to the page. If there are, make sure you resolve those references before renaming or moving the page.
|
|
|
|
# '''Replacing pages:''' If you need to replace a page completely, do so by replacing the '''content''' of the existing page, rather than moving the page to the Trash and creating a new page in its place. Replacing the content will leave the original page (and its UUID) in place, but with the new content. UUID's are used by the [[Eiffel Information System]] (EIS) to link EiffelStudio to documentation pages, and will be broken if the original page were to be deleted.
|
|
|
|
# '''Replacing pages:''' If you need to replace a page completely, do so by replacing the '''content''' of the existing page, rather than moving the page to the Trash and creating a new page in its place. Replacing the content will leave the original page (and its UUID) in place, but with the new content. UUID's are used by the [[Eiffel Information System]] (EIS) to link EiffelStudio to documentation pages, and will be broken if the original page were to be deleted.
|
|
|
|
# '''Using templates:''' While developing new pages or make significant changes to existing pages you may want to mark the tops of these pages with certain templates during the development process. You can click on "List templates" in the left margin to see the list of available templates. The "top-of-the-page" templates most useful during page maintenance are Beta, ReviewRequested, UnderConstruction, and UpdateNeeded. The meanings of these are described below.
|
|
|
|
# '''Using templates:'''
|
|
|
|
|
|
|
|
## There are several "templates" available for use within the text of documentation pages. For example, "Note", "SeeAlso", "Rule", "Definition", "Caution". You can click on "List templates" in the left margin to see the list of available templates.
|
|
|
|
|
|
|
|
## While developing new pages or make significant changes to existing pages you may want to mark the tops of these pages temporarily with certain templates during the development process. The "top-of-the-page" templates most useful during page maintenance are Beta, ReviewRequested, UnderConstruction, and UpdateNeeded. The meanings of these are described below.
|
|
|
|
|
|
|
|
|
|
|
|
===Documentation template meanings===
|
|
|
|
==="Top-of-the-page" Documentation template meanings===
|
|
|
|
|
|
|
|
|
|
|
|
====Beta====
|
|
|
|
====Beta====
|
|
|
|
|
|
|
|
|
|
|
|
Looks like this:
|
|
|
|
Looks like this:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{{Beta}}
|
|
|
|
{{Beta}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Means this:
|
|
|
|
Means this:
|
|
|
|
|
|
|
|
|
|
|
|
:Use this page with caution. This page is currently under development as a new page or a replacement for a previously existing page. It may contain information which describes capabilities not yet implemented. Avoid linking to this page. When this page comes out of beta, it is likely that the name and/or UUID of this page will change.
|
|
|
|
:''Use this page with caution. This page is currently under development as a new page or a replacement for a previously existing page. It may contain information which describes capabilities not yet implemented. Avoid linking to this page. When this page comes out of beta, it is likely that the name and/or UUID of this page will change.''
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
====ReviewRequested====
|
|
|
|
====ReviewRequested====
|
|
|
|
|
|
|
|
|
|
|
|
Looks like this:
|
|
|
|
Looks like this:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{{ReviewRequested}}
|
|
|
|
{{ReviewRequested}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Means this:
|
|
|
|
Means this:
|
|
|
|
|
|
|
|
|
|
|
|
:The material on this page needs to be reviewed for completeness and accuracy. If you have knowledge of this material, please review this page. If you are a [[Community|contributor]], feel free to make any appropriate additions and/or corrections, then remove this template. If not, you can note improvements on the [[Community#Using the Comments pages|comments]] page.
|
|
|
|
:''The material on this page needs to be reviewed for completeness and accuracy. If you have knowledge of this material, please review this page. If you are a [[Community|contributor]], feel free to make any appropriate additions and/or corrections, then remove this template. If not, you can note improvements on the [[Community#Using the Comments pages|comments]] page.''
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
====UnderConstruction====
|
|
|
|
====UnderConstruction====
|
|
|
|
|
|
|
|
|
|
|
|
Looks like this:
|
|
|
|
Looks like this:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{{UnderConstruction}}
|
|
|
|
{{UnderConstruction}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Means this:
|
|
|
|
Means this:
|
|
|
|
|
|
|
|
|
|
|
|
:Use this page with caution. This page is currently under development. It is likely that the information on this page is still incomplete.
|
|
|
|
:''Use this page with caution. This page is currently under development. It is likely that the information on this page is still incomplete. ''
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
====UpdateNeeded====
|
|
|
|
====UpdateNeeded====
|
|
|
|
|
|
|
|
|
|
|
|
Looks like this:
|
|
|
|
Looks like this:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{{UpdateNeeded}}
|
|
|
|
{{UpdateNeeded}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Means this:
|
|
|
|
Means this:
|
|
|
|
|
|
|
|
|
|
|
|
:Use this page with caution. This page has been identified as needing update. If you are a [[Community|contributor]], you can help by updating this page so that the information on it is current.
|
|
|
|
:''Use this page with caution. This page has been identified as needing update. If you are a [[Community|contributor]], you can help by updating this page so that the information on it is current.''
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
halw